Fix Rd documentation errors flagged by R CMD check#24
Merged
Conversation
…rs in Rd files Co-authored-by: asgr <5617132+asgr@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Review package for mistakes and improve documentation
Fix Rd documentation errors flagged by R CMD check
Feb 22, 2026
There was a problem hiding this comment.
Pull request overview
This PR addresses R CMD check documentation warnings by correcting Rd syntax and improving wording/examples across the package’s man pages, reducing checkRd “Lost braces” issues and fixing several typos/grammar problems.
Changes:
- Fixed Rd markup that caused
checkRd: (-1) Lost braceswarnings (notably\code{\link{...}}usage). - Corrected repeated typos/grammar (“explicitly”, “startrow”, “there are problematic”, etc.) across multiple man pages.
- Cleaned up
\seealso{}sections (removed placeholder~~~) and replaced an empty template example inRfits_gunzip.Rdwith a runnable example.
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| man/plot.Rfits.Rd | Removes placeholder ~~~ from \seealso{} to avoid Rd parse issues. |
| man/Rfits_table_hdf5.Rd | Fixes “explict” → “explicit” in header argument docs. |
| man/Rfits_table.Rd | Fixes typos (“explicitly”, “startrow”), repairs \code{\link{grep}} markup, and improves grammar. |
| man/Rfits_point.Rd | Repairs \code{\link{grep}} markup and improves grammar. |
| man/Rfits_key_scan.Rd | Repairs \code{\link{grep}} markup and improves grammar. |
| man/Rfits_image.Rd | Fixes “explictly” → “explicitly” and improves grammar in zap/NAcheck docs. |
| man/Rfits_header_convert.Rd | Repairs \code{\link{grep}} markup in zap docs. |
| man/Rfits_header.Rd | Improves grammar in zap docs. |
| man/Rfits_gunzip.Rd | Removes placeholder ~~~ in \seealso{} and adds a directly runnable example snippet. |
| man/Rfits_all_hdf5.Rd | Fixes “explict” → “explicit” and corrects class name typo (“Rfit_table” → “Rfits_table”). |
| man/Rfits_all.Rd | Repairs \code{\link{grep}} markup and fixes “explicitly” typo in NAcheck docs. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
asgr
approved these changes
Feb 22, 2026
Owner
asgr
left a comment
There was a problem hiding this comment.
All minor things that should be fixed.
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.
Fixes documentation mistakes across 11 man pages, primarily resolving the
checkRd: (-1) Lost braceswarnings from R CMD check.Lost braces (R CMD check warning)
code{\link{grep}}→\code{\link{grep}}in 5 files (Rfits_all, Rfits_header_convert, Rfits_key_scan, Rfits_point, Rfits_table)Typos
explict→explicit(Rfits_all, Rfits_image, Rfits_table, Rfits_table_hdf5, Rfits_all_hdf5)Rfit_table→Rfits_table(Rfits_all_hdf5)staterow→startrow(Rfits_table)Grammar
Cleanup
~~~from\seealsoin Rfits_gunzip.Rd and plot.Rfits.RdOriginal prompt
✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.