docs: fix minmax_run description and subtracted typo#114
Closed
LeonidasZhak wants to merge 1 commit into
Closed
Conversation
- minmax_run.Rd: fix description from 'min_run' to 'minmax_run', remove incorrect 'k window size' reference (function has no k param) - utils.R/.reformat_k: fix 'substracted' -> 'subtracted' typo Changes in roxygen source (src/minmax_run.cpp, R/utils.R), Rd files regenerated with roxygen2.
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
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.
Summary
Fixes two documentation issues in runner package:
minmax_run.Rd: Description incorrectly referenced
min_runinstead ofminmax_run, and mentioned "specifiedkwindow size" despiteminmax_runhaving nokparameter.dot-reformat_k.Rd (from
R/utils.R): Typo "substracted" → "subtracted".Changes
src/minmax_run.cppmin_run→minmax_run, removekreferenceR/RcppExports.RR/utils.Rman/minmax_run.Rdman/dot-reformat_k.RdValidation
tools::checkRd("man/minmax_run.Rd")— passestools::checkRd("man/dot-reformat_k.Rd")— passesR CMD build .— succeedsR CMD check runner_0.5.0.tar.gz --no-manual— Status: 1 WARNING (pre-existing dplyr undeclared), 1 NOTE (pre-existing .claude hidden dir), both unrelated to this changeRelated
max_runandwhich_rundescriptions but missedminmax_runna_rmparam description but not this issue