Skip to content

docs: fix typos and grammar in roxygen documentation#830

Closed
LeonidasZhak wants to merge 2 commits into
r-lib:mainfrom
LeonidasZhak:docs/fix-typos-in-docs
Closed

docs: fix typos and grammar in roxygen documentation#830
LeonidasZhak wants to merge 2 commits into
r-lib:mainfrom
LeonidasZhak:docs/fix-typos-in-docs

Conversation

@LeonidasZhak

Copy link
Copy Markdown
Contributor

Changes

  • Fix typo: "remote it" → "remove it" in ?stop_app (R/app.R:20)
  • Fix grammar: "These functions supports" → "These functions support" in ?cli_h1 (R/cli.R:283) and ?cli_alert (R/cli.R:798)

Files changed

  • R/app.R: roxygen source for stop_app() parameter docs
  • R/cli.R: roxygen source for cli_h1() and cli_alert() @Seealso tags
  • man/start_app.Rd: regenerated man page
  • man/cli_h1.Rd: regenerated man page
  • man/cli_alert.Rd: regenerated man page

Validation

  • tools::checkRd() passes on all three modified Rd files
  • No other instances of these typos remain in the package

Fixes #806. Add roxygen documentation for cli_progress_sleep() in the
progress C API header, matching the style of adjacent entries.
- Fix "remote it" -> "remove it" in ?stop_app (app.R)
- Fix "These functions supports" -> "These functions support" in
  ?cli_h1 and ?cli_alert (cli.R)
@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