Skip to content

Deduplicate @param documentation via @inheritParams#532

Merged
billdenney merged 3 commits intomainfrom
claude/deduplicate-function-docs-4Vs8f
Apr 12, 2026
Merged

Deduplicate @param documentation via @inheritParams#532
billdenney merged 3 commits intomainfrom
claude/deduplicate-function-docs-4Vs8f

Conversation

@billdenney
Copy link
Copy Markdown
Member

Summary

  • Replace redundant @param definitions for conc.blq, conc.na, check, first.tmax, and clast with @inheritParams from canonical source functions
  • Establish clean.conc.blq as the single canonical source for conc.blq, conc.na, and check parameters across the package
  • Inherit options from PKNCA.choose.option in pk.calc.ertmax (urine)
  • Remove duplicate clast/clast.obs/clast.pred definition from aucint.R (already inherited from pk.calc.auxc)

Canonical source functions

Parameter(s) Canonical Source Notes
conc.blq, conc.na, check clean.conc.blq Single source for all three
check (conc-only) pk.calc.cmax "Run [assert_conc()]?"
first.tmax pk.calc.tmax Full definition
clast, clast.obs, clast.pred pk.calc.auxc Combined definition
options PKNCA.choose.option Already primary source

Files changed (8)

  • R/auc.R — inherit conc.blq/conc.na/check from clean.conc.blq
  • R/half.life.R — inherit from clean.conc.blq and pk.calc.tmax
  • R/interpolate.conc.R — inherit from clean.conc.blq
  • R/tss.R — inherit from clean.conc.blq
  • R/aucint.R — remove duplicate clast params (already inherited via pk.calc.auxc)
  • R/pk.calc.simple.R — standardize check on tmax/tmin/tlast/clast.obs/ceoi
  • R/pk.calc.c0.R — inherit check from clean.conc.blq
  • R/pk.calc.urine.R — inherit options on pk.calc.ertmax

Test plan

  • Run devtools::document() to regenerate man/ pages
  • Verify no parameter documentation is lost (diff man/ before/after)
  • Run devtools::check() — no undocumented parameter warnings
  • Spot-check ?pk.calc.auxc, ?pk.calc.half.life, ?interp.extrap.conc

https://claude.ai/code/session_01P98oRHijPz2ZyT8Mx3nqUC

claude and others added 3 commits April 12, 2026 14:22
Replace redundant @param definitions for conc.blq, conc.na, check,
first.tmax, and clast with @inheritParams from canonical source
functions. This establishes clean.conc.blq as the single canonical
source for conc.blq, conc.na, and check parameters across the package.

Changes across 8 files:
- auc.R: inherit conc.blq/conc.na/check from clean.conc.blq
- half.life.R: inherit from clean.conc.blq and pk.calc.tmax
- interpolate.conc.R: inherit from clean.conc.blq
- tss.R: inherit from clean.conc.blq
- aucint.R: remove duplicate clast params (already inherited from pk.calc.auxc)
- pk.calc.simple.R: standardize check param on tmax/tmin/tlast/clast.obs/ceoi
- pk.calc.c0.R: inherit check from clean.conc.blq
- pk.calc.urine.R: inherit options on pk.calc.ertmax

https://claude.ai/code/session_01P98oRHijPz2ZyT8Mx3nqUC
Adds a GitHub Action that runs roxygen2::roxygenise() on pull requests
and commits any man/ or NAMESPACE changes back to the PR branch. This
ensures documentation stays in sync with roxygen2 comments without
requiring a local R installation.

https://claude.ai/code/session_01P98oRHijPz2ZyT8Mx3nqUC
@billdenney billdenney merged commit c7a3ed1 into main Apr 12, 2026
@billdenney billdenney deleted the claude/deduplicate-function-docs-4Vs8f branch April 12, 2026 14:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants