Repository navigation
Address CRAN review: documentation, examples and function side effects - #8
Merged
Merged
Conversation
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.
The CRAN review of rcosmo 1.1.5 identified incomplete documentation, disabled examples and function side effects. This PR expands the package Description, removes the redundant LICENSE file and its DESCRIPTION reference, documents all missing function return values and replacement arguments, and regenerates the help files.
Commented examples now use small synthetic maps, including a bundled complete twelve-pixel FITS map. Network download examples require an interactive session and use temporary destinations. Download functions require an explicit destination when saving; plotAngDis restores graphics settings on exit; invalid ring indices raise an error; and unconditional fitting diagnostics use suppressible warnings. Existing print/summary methods and progress output controlled by messages are retained. TinyTeX now updates its package manager before installing fonts, fixing a CI setup failure.
No new method references have been added to DESCRIPTION.
Validation: R and Rd parsing pass. All 56 runnable example blocks in the changed help files pass locally (maximum 1.51 seconds each), and all 15 focused regression assertions pass. These supplemental local checks used R 4.3.3 on a temporary copy with its minimum-R requirement adjusted; the repository still requires R >= 4.5.0. The coverage workflow passes on the final revision. Full supported-version R CMD checks are still running in GitHub Actions.