Skip to content

Fix Rd documentation errors flagged by R CMD check#24

Merged
asgr merged 2 commits intomasterfrom
copilot/improve-documentation-quality
Feb 22, 2026
Merged

Fix Rd documentation errors flagged by R CMD check#24
asgr merged 2 commits intomasterfrom
copilot/improve-documentation-quality

Conversation

Copy link
Contributor

Copilot AI commented Feb 22, 2026

Fixes documentation mistakes across 11 man pages, primarily resolving the checkRd: (-1) Lost braces warnings 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

  • explictexplicit (Rfits_all, Rfits_image, Rfits_table, Rfits_table_hdf5, Rfits_all_hdf5)
  • Rfit_tableRfits_table (Rfits_all_hdf5)
  • staterowstartrow (Rfits_table)

Grammar

  • "if there a problematic" → "if there are problematic" (7 files)
  • "we have often need to use" → "we often need to use" (4 files)

Cleanup

  • Removed placeholder ~~~ from \seealso in Rfits_gunzip.Rd and plot.Rfits.Rd
  • Replaced empty template example in Rfits_gunzip.Rd with a working example
Original prompt

General package review looking for mistakes. Improve quality of documentation where lacking (creating more examples where useful)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…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
Copilot AI requested a review from asgr February 22, 2026 02:17
@asgr asgr requested review from Copilot and removed request for asgr February 22, 2026 02:35
@asgr asgr self-requested a review February 22, 2026 02:36
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 braces warnings (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 in Rfits_gunzip.Rd with 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.

Copy link
Owner

@asgr asgr left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All minor things that should be fixed.

@asgr asgr marked this pull request as ready for review February 22, 2026 02:39
@asgr asgr merged commit ca161fc into master Feb 22, 2026
14 checks passed
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