Skip to content

Correct CTD pressure adjustment and sigmaTheta documentation - #2383

Merged
richardsc merged 1 commit into
dankelley:developfrom
dajiaohuang:docs/ctd-contracts-20261016
Oct 18, 2026
Merged

richardsc merged 1 commit into
dankelley:developfrom
dajiaohuang:docs/ctd-contracts-20261016

Conversation

@dajiaohuang

Copy link
Copy Markdown
Contributor

Correct two existing CTD help statements to match the public API:

  • as.ctd() subtracts pressureAtmospheric from pressure; its pressure argument description currently says it stores their sum, contradicting both the implementation and the pressureAtmospheric argument description.
  • The sigmaTheta accessor computes swSigmaTheta(x), not swTheta(x), and it takes precedence over a stored sigmaTheta item (rather than a stored theta item).

Only canonical roxygen comments and their generated Rd files change. Regenerated with the package's recorded roxygen2 7.3.2; no other generated changes.

Validation: R 4.3.3 / Ubuntu 24.04, synthetic public-API calls verified pressure subtraction and that computed sigmaTheta overrides a deliberately stored value. Both changed Rd files pass tools::checkRd. Runtime code is unchanged; the same base's build/install/load and representative synthetic usage were checked during this pass. Full upstream tests/examples, vignettes and manual generation were not run.

@richardsc

Copy link
Copy Markdown
Collaborator

Thanks for catching these. They look good to me -- I'll wait for @dankelley to approve before merging.

@dankelley

Copy link
Copy Markdown
Owner

@Clark, I clicked 'approve'. But please wait for those CI checks to complete before merging. They can be slow -- maybe just check this afternoon.

@dankelley

Copy link
Copy Markdown
Owner

Oh, I meant @richardsc ... sorry to whoever "at"clark might be!

@richardsc
richardsc merged commit 538cac7 into dankelley:develop Oct 18, 2026
5 checks passed
@richardsc

Copy link
Copy Markdown
Collaborator

Checks passed, I'll merge. Thanks!

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.

3 participants