docs: fix malformed Rd syntax in @param k description#113
Closed
LeonidasZhak wants to merge 1 commit into
Closed
Conversation
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)
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. |
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.
Summary
Fix double backtick in
sum_run's@param kroxygen comment that produces broken\verb{}output insum_run.Rdandmean_run.Rd.Before:
Renders as:
\verb{integer`` vector or single value)...}— malformed Rd.After:
Renders as:
\code{integer} vector or single value— correct Rd.Problem
In
src/runner.cppline 783, the roxygen comment for@param khad a double backtick instead of a single backtick. This causedroxygen2to generate broken\verb{}Rd markup insum_run.Rdandmean_run.Rd(which inherits fromsum_runvia@inheritParams).Validation
tools::checkRd('man/sum_run.Rd')— passestools::checkRd('man/mean_run.Rd')— passestinytest::test_package('runner')— All ok)src/runner.cpp), 3 Rd files regeneratedFiles Changed
src/runner.cpp->`` in@param k`R/RcppExports.Rman/sum_run.Rdman/mean_run.Rdman/runner.RdDuplicate Check
@param k@param k