docs: Attach the "How to use the data sets" section to the package page - #59
Open
krlmlr wants to merge 1 commit into
Open
docs: Attach the "How to use the data sets" section to the package page#59krlmlr wants to merge 1 commit into
krlmlr wants to merge 1 commit into
Conversation
The section documented nothing. Two blank lines separated its roxygen block from the `NULL` below it, so roxygen2 ended the block at the gap and found no object to attach it to, and dropped it without a word. `@section` also requires a trailing colon after the title, which it did not have. Neither mistake produces a warning; the text simply never reached `man/igraphdata-package.Rd`. It is moved into the `"_PACKAGE"` block at the top of the file, which is where package-level documentation belongs and where it now renders -- `tools::Rd2txt()` shows the section between Description and Author(s). The prose is unchanged. Found while reformatting this file for line breaks; it is a separate change because it alters rendered output, which that pass does not. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
krlmlr
force-pushed
the
claude/fix-orphan-section
branch
from
September 14, 2026 05:45
c5ec157 to
f9c797d
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
@section How to use the data setsblock inR/igraphdata-package.Rdocuments nothing, and has not for as long as it has existed.Two separate mistakes, neither of which produces a warning. Two blank lines separate the block from the
NULLbelow it, so roxygen2 ends the block at the gap and finds no object to attach it to — and silently drops it. And@sectionrequires a trailing colon after the title, which it does not have. The text simply never reachesman/igraphdata-package.Rd; you can confirm it against the current file.It moves into the
"_PACKAGE"block at the top of the file, which is where package-level documentation belongs.tools::Rd2txt("man/igraphdata-package.Rd")now shows the section between Description and Author(s). The prose itself is unchanged.Found while reformatting this file for line breaks. It is a separate pull request because it changes rendered output, which that pass deliberately does not — and because it is worth reviewing on its own rather than buried in a reformatting diff.
Independent of the documentation chain (#56, #57, #58) and based on
main.🤖 Generated with Claude Code
https://claude.ai/code/session_01WWhverMTZZKgEpUuTK117m
Generated by Claude Code