docs: use "ID"/"IDs" consistently in documentation prose#2694
Merged
Conversation
Sweep roxygen prose to write "ID"/"IDs" instead of "id"/"ids" when
referring to vertex and edge IDs, per the agreed convention. Lowercase
is preserved where the token is code: argument names, runnable
`@examples`, `\preformatted` and fenced code blocks, and `` `...` `` /
`\code{}` spans.
Add `tools/check-id-casing.R`, a dependency-free checker that flags
stray lowercase id/ids in roxygen prose, and document the convention in
AGENTS.md and CONTRIBUTING.md.
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
This is how benchmark results would change (along with a 95% confidence interval in relative change) if 3632c85 is merged into main:
|
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
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.
Fix #1683
Sweep roxygen prose to write "ID"/"IDs" instead of "id"/"ids" when referring to vertex and edge IDs, per the agreed convention. Lowercase is preserved where the token is code: argument names, runnable
@examples,\preformattedand fenced code blocks, and`...`/\code{}spans.Add
tools/check-id-casing.R, a dependency-free checker that flags stray lowercase id/ids in roxygen prose, and document the convention in AGENTS.md and CONTRIBUTING.md.