Skip to content

docs: fix bare infinitive 'allows to' in rleid.Rd and data.table.Rd#7785

Closed
LeonidasZhak wants to merge 1 commit into
Rdatatable:masterfrom
LeonidasZhak:docs/fix-rleid-datatable-bare-infinitive
Closed

docs: fix bare infinitive 'allows to' in rleid.Rd and data.table.Rd#7785
LeonidasZhak wants to merge 1 commit into
Rdatatable:masterfrom
LeonidasZhak:docs/fix-rleid-datatable-bare-infinitive

Conversation

@LeonidasZhak

Copy link
Copy Markdown

Summary

Fix two instances of the bare infinitive grammatical error 'allows to' in data.table documentation.

Problem

The verb 'allow' requires a gerund (allow + -ing) or a noun phrase before 'to' (allow + someone + to). Two Rd files contain the bare infinitive error 'allows to':

  1. rleid.Rd line 19: 'This function allows to generate' — bare infinitive error
  2. data.table.Rd line 84: 'This allows to not just select' — bare infinitive error

Fix

File Line Before After
man/rleid.Rd 19 'allows to generate' 'allows generating'
man/data.table.Rd 84 'allows to not just select' 'allows not just selecting'

Files Changed

File Lines Changed Type
man/rleid.Rd 1 Documentation
man/data.table.Rd 1 Documentation
Total 2

Validation

  • tools::checkRd('man/rleid.Rd') — passes (no output = no errors)
  • tools::checkRd('man/data.table.Rd') — passes (no output = no errors)
  • Change is purely documentation (no code changes)

Duplicate Check

Stata Migration Relevance

The rleid function is commonly used for creating group identifiers in panel data workflows, which is a frequent pattern for Stata users migrating to R. Stata's bysort command combined with egen group() provides similar functionality. Clear documentation of rleid helps Stata users understand how to create run-length group identifiers.

The data.table.Rd documentation is the primary reference for data.table's syntax, which is essential for Stata users learning R's data manipulation paradigm. The j expression documentation explains how to select and compute on columns, which maps to Stata's egen and generate commands.

Tests Actually Run

  • tools::checkRd() validation on both modified files
  • No code changes, so no test suite needed

Fix two instances of the bare infinitive grammatical error 'allows to'
in data.table documentation:

- rleid.Rd: 'allows to generate' → 'allows generating'
- data.table.Rd: 'allows to not just select' → 'allows not just selecting'

The verb 'allow' requires a gerund (allow + -ing) or a noun phrase
before 'to' (allow + someone + to). 'Allows to generate' and
'allows to not just select' are bare infinitive errors.

These follow the same pattern as the frollapply.Rd fix in PR #7784.
@LeonidasZhak

Copy link
Copy Markdown
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