docs: standardize roxygen tag @return to @returns across R/ (#1363) - #1417
Open
wangzhengdna-lang wants to merge 2 commits into
Open
docs: standardize roxygen tag @return to @returns across R/ (#1363)#1417wangzhengdna-lang wants to merge 2 commits into
wangzhengdna-lang wants to merge 2 commits into
Conversation
…rse#1363) Project convention (AGENTS.md) is @returns; 12 files still used @return (31 occurrences). Pure find-replace plus one line wrap in l_pkcl01.R to stay within the 100-char limit. No man/ changes: both tags generate identical \value sections (docs regenerated under the project's RoxygenNote 7.3.3 standard remain byte-identical).
wangzhengdna-lang
requested review from
Gero1999,
Shaakon35 and
h5hoang
as code owners
August 5, 2026 05:15
…1363) The 100-char line wrap in the roxygen source changes the \value text in the generated Rd. Regenerated; the Roxygen CI check (7.3.3) expects it.
Author
|
Follow-up commit Root cause: the line wrap I made in Fix: regenerated |
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.
Issue
Closes #1363
Description
Project convention (AGENTS.md, and the majority of the codebase) is the roxygen tag
@returns, but 12 files still used@return(31 occurrences). This PR is a pure find-replace to@returns, plus one line wrap inR/l_pkcl01.Rwhere the extra character pushed a doc line past the 100-character lint limit.Files touched:
R/exploration_plots.R,R/pk_dose_qc_plot.R,R/filter_breaks.R,R/PKNCA_extra_parameters.R,R/utils-slope_selector.R,R/PKNCA.R,R/flexible_violinboxplot.R,R/utils-plots.R,R/label_operators.R,R/export_cdisc.R,R/get_session_code.R,R/l_pkcl01.R.No
man/changes: both tags generate identical\value{}sections, so the regenerated documentation is byte-identical.Definition of Done
@return(without thes) remains inR/devtools::document()run to regenerateman/(no output changes)lintrand tests passHow to test
Documentation-only change; no behavior affected. Verified: zero
@return(without s) left inR/,lintr::lint_package()0 lints, full test suite 2005 PASS / 0 FAIL, spellcheck clean.Contributor checklist
.scsschange was done, rundata-raw/compile_css.Rdata-raw/test_suggests_hidden.RNotes to reviewer
Docs regenerated under the project RoxygenNote 7.3.3 standard produce no
man/diff, so the PR contains only the roxygen source edits.