Skip to content

docs: fix grammar in hop.Rd example comment#232

Closed
LeonidasZhak wants to merge 2 commits into
r-lib:mainfrom
LeonidasZhak:docs/fix-hop-lets-grammar
Closed

docs: fix grammar in hop.Rd example comment#232
LeonidasZhak wants to merge 2 commits into
r-lib:mainfrom
LeonidasZhak:docs/fix-hop-lets-grammar

Conversation

@LeonidasZhak

Copy link
Copy Markdown

Summary

Fixed grammar error in the hop() example comment in R/hop.R (roxygen source) and man/hop.Rd (auto-generated).

Before: hop() let's you manually specify locations to apply .f at.
After: hop() lets you manually specify locations to apply .f at.

Problem

"let's" is a contraction of "let us", but the intended meaning is "allows" (third-person singular present tense of "to let"). The sentence describes what hop() does — it lets (allows) the user to specify locations.

Validation

  • tools::checkRd("man/hop.Rd") — passes (no output = no errors)
  • 2 files changed, 2 lines modified

Files Changed

File Line Type
R/hop.R 80 Roxygen source
man/hop.Rd 122 Auto-generated Rd

The inline code references to dates in the  example had
extra leading double-quotes: `""2019-09-03"` instead of
`"2019-09-03"`. Fixed in roxygen source and regenerated Rd.
Change let's (let us) to lets (allows) in the hop() example comment.
@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