Improve sentence style in @param documentation - #2455
Merged
Conversation
yihui
force-pushed
the
fix-param-sentence-style
branch
3 times, most recently
from
August 27, 2026 18:10
d2c9e2e to
633ac80
Compare
Improve the roxygen documentation in two ways: 1. Sentence style (#1481): standardize @PARAM descriptions to proper sentences (capitalized, ending with a period), convert "Boolean;/Logical:" prefixes to "Whether to ...", and fix serial commas in "e.g.". 2. Markdown conversion: enable Roxygen markdown support and convert LaTeX-style markup to markdown using the roxygen2md package: - \code{x} -> `x` - \emph{x} -> *x* - \url{x} -> <x> - \href{u}{t} -> [t](u) - \code{\link{fn}} -> [fn()] - \code{pkg::\link{fn}} -> [pkg::fn()] Mixed link+method constructs (e.g. opts_chunk$set(), iconv(x, ...)) are kept as \code{\link{}} since markdown has no clean nested form. Object links (knit_patterns, all_patterns) use [obj] without parens. Special-cased to avoid breakage: - Inline `r ...` expressions in fig_chunk/inline_expr docs are kept literal so they are not evaluated. - Code blocks in convert_chunk_header docs use 4-backtick fences so the inner triple backticks survive markdown processing. All .Rd files regenerated and verified to parse cleanly. Closes #1481 Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
yihui
force-pushed
the
fix-param-sentence-style
branch
from
August 27, 2026 18:24
633ac80 to
716cdd7
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
1 participant
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.
Summary
@paramdescriptions to proper sentence style (capitalize, end with period)Changes
@paramblocks improved across 11 R filesCloses #1481
🤖 Generated with Claude Code