Repository navigation
Correct CTD pressure adjustment and sigmaTheta documentation - #2383
Merged
richardsc merged 1 commit intoOct 18, 2026
Merged
Conversation
Collaborator
|
Thanks for catching these. They look good to me -- I'll wait for @dankelley to approve before merging. |
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. |
Owner
|
Oh, I meant @richardsc ... sorry to whoever "at"clark might be! |
Collaborator
|
Checks passed, I'll merge. Thanks! |
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.
Correct two existing CTD help statements to match the public API:
as.ctd()subtractspressureAtmosphericfrompressure; itspressureargument description currently says it stores their sum, contradicting both the implementation and thepressureAtmosphericargument description.sigmaThetaaccessor computesswSigmaTheta(x), notswTheta(x), and it takes precedence over a storedsigmaThetaitem (rather than a storedthetaitem).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.