Skip to content

docs: fix bare infinitive 'allows to fill' in fill_run.Rd#116

Closed
LeonidasZhak wants to merge 1 commit into
gogonzo:mainfrom
LeonidasZhak:docs/fix-fill-run-bare-infinitive
Closed

docs: fix bare infinitive 'allows to fill' in fill_run.Rd#116
LeonidasZhak wants to merge 1 commit into
gogonzo:mainfrom
LeonidasZhak:docs/fix-fill-run-bare-infinitive

Conversation

@LeonidasZhak

Copy link
Copy Markdown
Contributor

Summary

Fixed bare infinitive grammatical error "allows to fill" in the @param run_for_first description of fill_run().

Problem

The verb "allow" requires a gerund (allow + -ing) or a noun phrase before "to" (allow + someone + to). The current documentation states:

run_for_first = TRUE allows to fill all initial NA with nearest non-NA value.

This is a bare infinitive error.

Fix

Changed "allows to fill" to "allows filling":

run_for_first = TRUE allows filling all initial NA with nearest non-NA value.

Files Changed

File Lines Changed Type
src/fill_run.cpp 1 Documentation (roxygen source)
R/RcppExports.R 1 Documentation (generated)
man/fill_run.Rd 1 Documentation (generated)
DESCRIPTION 1 roxygen2 version update
Total 4

Validation

  • tools::checkRd('man/fill_run.Rd') — passes (no output = no errors)
  • R CMD check --no-manual --no-tests --no-vignettes --no-examples — Status: OK (pre-existing WARNING about unstated dplyr dependency in examples, unrelated to this change)
  • Change is purely documentation (no code changes)

Duplicate Check

Stata Migration Relevance

The fill_run() function is useful for Stata users migrating to R, as it provides functionality similar to Stata's fill command for carrying forward values. Clear documentation of the run_for_first parameter helps Stata users understand how to handle initial missing values, which is a common data cleaning operation.

PR URL

#116

Changed 'allows to fill' to 'allows filling' in the @param run_for_first
description. The verb 'allow' requires a gerund (allow + -ing) or a noun
phrase before 'to' (allow + someone + to).

Files changed:
- src/fill_run.cpp (roxygen source)
- R/RcppExports.R (generated)
- man/fill_run.Rd (generated)
- DESCRIPTION (roxygen2 version update)
@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.

1 participant