docs: fix na_rm param description inherited by all *_run functions#112
Closed
LeonidasZhak wants to merge 1 commit into
Closed
docs: fix na_rm param description inherited by all *_run functions#112LeonidasZhak wants to merge 1 commit into
LeonidasZhak wants to merge 1 commit into
Conversation
The na_rm parameter in sum_run.Rd described behavior as 'sum is calculating excluding NA', but this description is inherited via @inheritParams by mean_run, streak_run, which_run, min_run, max_run, and minmax_run — where 'sum' is incorrect. Changed to generic: 'missing values are removed before calculation' Affects 7 functions total. All 1043 tinytest tests pass.
gogonzo
approved these changes
Jun 6, 2026
This was referenced Jun 7, 2026
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
2 participants
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
The
na_rmparameter description insum_run.Rdsays "sum is calculating excluding NA", but this description is inherited via@inheritParams sum_runby all other*_runfunctions — making it wrong for , , , , , and .Before (all 7 functions)
After (all 7 functions)
Validation
tools::checkRd()passes for all affected Rd filesFiles Changed
Duplicate Check