Merge pull request #590 from lorenzwalthert/fix-spelling

- fix spelling (#590).

Author: lorenzwalthert

NEWS.md

@@ -36,7 +36,7 @@
 
 * lines are now broken after `+` in `ggplot2` calls for `strict = TRUE` (#569).
 
-* function documentation now contains many more linebreaks due to roxygen2 
+* function documentation now contains many more line breaks due to roxygen2 
   update to version 7.0.1 (#566).
 
 * spaces next to the braces in subsetting expressions `[` and `[[` are now

R/nest.R

@@ -58,7 +58,7 @@ add_cache_block <- function(pd_nested) {
 #'
 #' **usual case: All other expressions in a block are cached**
 #'
-#' Cached expressiond don't need to be transformed with `transformers` in
+#' Cached expressions don't need to be transformed with `transformers` in
 #' [parse_transform_serialize_r_block()], we simply return `text` for the top
 #' level token. For that
 #' reason, the nested parse table can, at the rows where these expressions are
@@ -106,7 +106,7 @@ drop_cached_children <- function(pd) {
 #' To make a parse table shallow, we must know which ids to keep.
 #' `split(cumsum(pd_parent_first$parent < 1))` above puts comments with negative
 #' parents in the same block as proceeding expressions. `find_pos_id_to_keep()`
-#' must hence alyways keep comments. We did not use
+#' must hence always keep comments. We did not use
 #' `split(cumsum(pd_parent_first$parent < 1))` because then every comment is an
 #' expression on its own and processing takes much longer for typical roxygen
 #' annotated code
@@ -140,7 +140,7 @@ find_pos_id_to_keep <- function(pd) {
 #' To use something else as start and stop markers, set the R options
 #' `styler.ignore_start` and
 #' `styler.ignore_stop` using [options()]. If you want these
-#' settings to persist over mulitple R sessions, consider setting them in your
+#' settings to persist over multiple R sessions, consider setting them in your
 #' R profile, e.g. with `usethis::edit_rprofile()`.
 #' @name stylerignore
 #' @examples

R/relevel.R

@@ -182,7 +182,7 @@ relocate_eq_assign_nest <- function(pd) {
 #'
 #' Two assignment tokens `EQ_ASSIGN` belong to the same block if they are not
 #' separated by more than one token. Token between `EQ_ASSIGN` tokens belong
-#' to the `EQ_ASSIGN` token occurring before them, except the token right before
+#' to the `EQ_ASSIGN` token occuring before them, except the token right before
 #' `EQ_ASSING` already belongs to the `EQ_ASSING` after it. Note that this
 #' notion is unrelated to the column *block* in the parse table, which is used
 #' to [parse_transform_serialize_r()] code blocks and leave out the ones that

R/roxygen-examples-parse.R

@@ -1,7 +1,7 @@
 #' Parse roxygen comments into text
 #'
 #' Used to parse roxygen code examples. Removes line break before
-#' `\\dontrun{...}` and friends because it does not occurr for segments other
+#' `\\dontrun{...}` and friends because it does not occur for segments other
 #' than `\\dont{...}` and friends.
 #' @param roxygen Roxygen comments.
 #' @examples

R/rules-line-break.R

@@ -127,7 +127,7 @@ style_line_break_around_curly <- function(strict, pd) {
 #' sugar according to the above definition. On the other hand `\{\{ x + y \}\}`
 #' is recognized by styler as containing it (and is parsable code)
 #' but will most likely give an error at runtime because the way the syntactic
-#' suggar is defined in rlang is to use a single token within curly-curly. In
+#' sugar is defined in rlang is to use a single token within curly-curly. In
 #' addition, because rlang parses `\{\{` in a special way (just as `!!`), the
 #' expression `\{\{ x \}\}` will give a runtime error when used outside of a
 #' context that is capable of handling it, e.g. on the top level (that is, not

R/testing-mocks.R

@@ -7,7 +7,7 @@
 #' with multiple curly braces in a sequence. It is important to maintain testing
 #' for indention rules even as the curly-curly expression is always kept on the
 #' same line in the tidyverse style guide because we should
-#' ensure the underlaying mechanics for indention work correctly. When
+#' ensure the underlying mechanics for indention work correctly. When
 #' indention mechanisms are changed later, e.g. by simplifying
 #' [compute_indent_indices()], we must have
 #' a way of testing this without the interaction of `\{\{`.

R/testing.R

@@ -196,7 +196,7 @@ testthat_file <- function(...) {
   file.path(rprojroot::find_testthat_root_file(), ...)
 }
 
-#' Convert a serialized R object to a certaion version.
+#' Convert a serialized R object to a certain version.
 #'
 #' Needed to make [testthat::expect_known_value()] work on R < 3.6.
 #' @param path A path to an rds file.

R/transform-block.R

@@ -38,7 +38,7 @@ parse_transform_serialize_r_block <- function(pd_nested,
 #' Multiple expressions can sit on one row, e.g. in line comment and commands
 #' separated with ";". This creates a problem when processing each expression
 #' separately because when putting them together, we need complicated handling
-#' of line breaks between them, as it is not apriory clear that there is a line
+#' of line breaks between them, as it is not apriori clear that there is a line
 #' break separating them. To avoid this, we put top level expressions that sit
 #' on the same line into one block, so the assumption that there is a line break
 #' between each block of expressions holds.

R/ui-caching.R

@@ -2,7 +2,7 @@
 #'
 #' Clears the cache that stores which files are already styled. You won't be
 #' able to undo this. Note that the file corresponding to the cache (a folder
-#' on your file stystem) won't be deleted, but it will be empty after calling
+#' on your file system) won't be deleted, but it will be empty after calling
 #' `cache_clear`.
 #' @param cache_name The name of the styler cache to use. If
 #'   `NULL`, the option "styler.cache_name" is considered which defaults to

R/utils-cache.R

@@ -67,8 +67,8 @@ is_cached <- function(text, transformers, cache_dir = cache_dir_default()) {
 #' * Our caching backend package, `R.cache`, uses
 #'   `R.cache:::getChecksum.default` (which uses `digest::digest()`) to hash the
 #'   input. The latter does not seem to care if the environments are exactly
-#'   equal (see 'Exampels').
-#' * However, under stome circumstances, it does: Commit 9c94c022 (if not
+#'   equal (see 'Examples').
+#' * However, under some circumstances, it does: Commit 9c94c022 (if not
 #'   overwritten / rebased by now) contains a reprex. Otherwise, search for
 #'   43219ixmypi in commit messages and restore this commit to reproduce the
 #'   behavior.