Skip to content

docs: fix typos in roxygen documentation - #139

Open
Avicennasis wants to merge 1 commit into
rstudio:mainfrom
Avicennasis:docs/fix-typos
Open

docs: fix typos in roxygen documentation#139
Avicennasis wants to merge 1 commit into
rstudio:mainfrom
Avicennasis:docs/fix-typos

Conversation

@Avicennasis

Copy link
Copy Markdown

Summary

Fixes 8 typos in roxygen documentation. Edits are made in the roxygen comments under R/, and the corresponding man/*.Rd files are updated to match so the tree stays consistent without needing a devtools::document() round-trip. Documentation only - no exported function, argument or object name is changed.

  • R/tbl_check_names.R, R/tbl_check_groups.R, R/tbl_check_dimensions.R: the names/groups/dimensions of two object are the same -> ... of two objects are the same (all three titles share the wording, so all three are corrected)
  • R/tbl_check_names.R: `tbl_check_names()` and `vec_check_names()` returns a list -> ... return a list (compound subject)
  • R/tbl_check_names.R: `tbl_grade_names()` and `vec_grade_names()` returns a failing grade -> ... return a failing grade
  • R/vec_check_values.R: Checks that two vectors are contain the same values -> Checks that two vectors contain the same values
  • R/tbl_check_column.R: `object` doesn't contain a column named column. -> `object` doesn't contain a column named `column`. (every other bullet in that @section Problems block already code-formats column)
  • R/tbl_check_column.R: @param check_levels ... Whether to check that `column` and has the same [factor levels][levels()] -> ... Whether to check that `column` has the same [factor levels][levels()] (stray and; the sibling check_class, check_length, check_values and check_names params all read Whether to check that column has the same ...)

Regenerated man/ files touched: tbl_check_names.Rd, tbl_check_groups.Rd, tbl_check_dimensions.Rd, vec_check_values.Rd, tbl_check_column.Rd.

Note on the singular returns: the other - fn() returns ... bullets across the package have a single function as the subject and are correct as written, so they are deliberately left alone. Only the two lines in tbl_check_names.R have two functions joined by and.

@CLAassistant

CLAassistant commented Sep 3, 2026

Copy link
Copy Markdown

CLA assistant check
All committers have signed the CLA.

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.

2 participants