Skip to content

docs: fix malformed Rd syntax in @param k description#113

Closed
LeonidasZhak wants to merge 1 commit into
gogonzo:mainfrom
LeonidasZhak:docs/fix-k-param-rd-syntax
Closed

docs: fix malformed Rd syntax in @param k description#113
LeonidasZhak wants to merge 1 commit into
gogonzo:mainfrom
LeonidasZhak:docs/fix-k-param-rd-syntax

Conversation

@LeonidasZhak

Copy link
Copy Markdown
Contributor

Summary

Fix double backtick in sum_run's @param k roxygen comment that produces broken \verb{} output in sum_run.Rd and mean_run.Rd.

Before:

@param k (`integer`` vector or single value)

Renders as: \verb{integer`` vector or single value)...} — malformed Rd.

After:

@param k (`integer` vector or single value)

Renders as: \code{integer} vector or single value — correct Rd.

Problem

In src/runner.cpp line 783, the roxygen comment for @param k had a double backtick instead of a single backtick. This caused roxygen2 to generate broken \verb{} Rd markup in sum_run.Rd and mean_run.Rd (which inherits from sum_run via @inheritParams).

Validation

  • tools::checkRd('man/sum_run.Rd') — passes
  • tools::checkRd('man/mean_run.Rd') — passes
  • All 1043 tinytest tests pass (tinytest::test_package('runner') — All ok)
  • 1 source file changed (src/runner.cpp), 3 Rd files regenerated

Files Changed

File Change
src/runner.cpp 1 char fix: -> `` in@param k`
R/RcppExports.R Auto-regenerated
man/sum_run.Rd Auto-regenerated
man/mean_run.Rd Auto-regenerated
man/runner.Rd Cross-ref normalization

Duplicate Check

Fix double backtick (`integer`` -> `integer`) in sum_run's @param k
roxygen comment that produced broken \verb{} output in sum_run.Rd and
mean_run.Rd (which inherits from sum_run via @inheritParams).

Before: \verb{integer`` vector or single value)...}
After:  \code{integer} vector or single value)

@gogonzo gogonzo left a comment

Copy link
Copy Markdown
Owner

Choose a reason for hiding this comment

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

Thanks!

@LeonidasZhak

Copy link
Copy Markdown
Contributor Author

Withdrawing this small automated PR while I consolidate an oversized batch of contributions and reduce maintainer review burden. Sorry for the noise, and thank you for maintaining the project.

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.

2 participants