docs: fix typos in roxygen documentation - #139
Open
Avicennasis wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Fixes 8 typos in roxygen documentation. Edits are made in the roxygen comments under
R/, and the correspondingman/*.Rdfiles are updated to match so the tree stays consistent without needing adevtools::document()round-trip. Documentation only - no exported function, argument or object name is changed.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)`tbl_check_names()` and `vec_check_names()` returns a list->... return a list(compound subject)`tbl_grade_names()` and `vec_grade_names()` returns a failing grade->... return a failing gradeChecks that two vectors are contain the same values->Checks that two vectors contain the same values`object` doesn't contain a column named column.->`object` doesn't contain a column named `column`.(every other bullet in that@section Problemsblock already code-formatscolumn)@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()](strayand; the siblingcheck_class,check_length,check_valuesandcheck_namesparams all readWhether to check thatcolumnhas 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 intbl_check_names.Rhave two functions joined byand.