Merge pull request #294 from lorenzwalthert/spelling

- Spelling via devtools::spell_check() (#294).

Author: lorenzwalthert

R/communicate.R

@@ -1,4 +1,4 @@
-#' Communiate a warning if necessary
+#' Communicate a warning if necessary
 #'
 #' If roundtrip verification was not possible, issue a warning to review the
 #' changes carefully.

R/expr-is.R

@@ -39,7 +39,7 @@ contains_else_expr <- function(pd) {
 #' Checks whether an else expression in a nest needs braces. Note that for
 #' if-else-if expressions, there is no need to add braces since the if in
 #' else-if will be visited separately with the visitor. This applies to all
-#' conditional statents with more than one alternative.
+#' conditional statmements with more than one alternative.
 #' @param pd A parse table
 contains_else_expr_that_needs_braces <- function(pd) {
   else_idx <- which(pd$token == "ELSE")

R/indent.R

@@ -194,8 +194,8 @@ pd_is_multi_line <- function(pd) {
 
 #' Update the newlines attribute
 #'
-#' As we work only with the `lag_newlines` attribute for setting the linebreaks,
-#' (R/rules-line_break.R) but we need `newlines` to determine
+#' As we work only with the `lag_newlines` attribute for setting the line
+#' breaks, (R/rules-line_break.R) but we need `newlines` to determine
 #' whether or not to set `spaces` (R/rules-spacing.R), we have to update the
 #' attribute. We cannot simply use `dplyr::lead(pd$lag_newlines)` since we would
 #' lose information for the last token. `spaces` is left as is in

R/parse.R

@@ -37,7 +37,7 @@ get_parse_data <- function(text, include_text = TRUE, ...) {
 
 #' Add column `pos_id` and `short`
 #'
-#' Addds column `pos_id` and `short` to a flat parse table.
+#' Adds column `pos_id` and `short` to a flat parse table.
 #' @param pd A flat parse table
 add_id_and_short <- function(pd) {
   pd$pos_id <- seq2(1L, nrow(pd))

R/relevel.R

@@ -130,15 +130,15 @@ relocate_eq_assign <- function(pd) {
 #' within a *nest* (nested parse table at one level of nesting).
 #' Note that one assignment expression (such as "a = b = c") can include
 #' multiple assignment operators, an assignment involves just one assignment
-#' oparator.
+#' operator.
 #' For the relocation of assignment expressions that contain `EQ_ASSIGN` within
 #' a *nest*, we need to first find the expressions that contain `=` and then
 #' split the *nest* into parse tables each containing one such assignment
 #' expression and then relocate each of them separately.
 #' We can't do all of them together because:
 #'
 #'  * An assignment can contain more than just three tokens, e.g. (a <- b <- c).
-#'  * Two assignemnts can be in the same nest although they don't belong to the
+#'  * Two assignments can be in the same nest although they don't belong to the
 #'    same assignment (if-else statement).
 #'
 #' Please refer to the section 'Examples' in [relocate_eq_assign()] for details.
@@ -160,7 +160,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 occuring before them, except the token right before
+#' to the `EQ_ASSIGN` token occurring before them, except the token right before
 #' `EQ_ASSING` already belongs to the `EQ_ASSING` after it.
 #' @param pd A parse table.
 find_block_id <- function(pd) {

R/rules-other.R

@@ -24,7 +24,7 @@ add_brackets_in_pipe_one <- function(pd, pos) {
 #' Wrap an if-else statement in curly braces if it is not already wrapped in
 #' a such.
 #' @param pd A parse table.
-#' @param indent_by The amont of spaces used to indent an expression in curly
+#' @param indent_by The amount of spaces used to indent an expression in curly
 #'   braces. Used for unindention.
 wrap_if_else_multi_line_in_curly <- function(pd, indent_by = 2) {
   if (is_cond_expr(pd)) {

R/serialized_tests.R

@@ -229,7 +229,7 @@ stop_insufficient_r_version <- function() {
 
 #' Generate a comprehensive collection test cases for comment / insertion
 #' interaction
-#' Test consist of if / if-else / if-else-if-else caes, paired with various
+#' Test consist of if / if-else / if-else-if-else cases, paired with various
 #' line-break and comment configurations. Used for internal testing.
 #' @return
 #' The function is called for its side effects, i.e. to write the

R/token-create.R

@@ -74,7 +74,7 @@ create_pos_ids <- function(pd, pos, by = 0.1, after = FALSE, n = 1) {
 #' Find legit starting value for a new positional id
 #'
 #' Looks at the current nest as well as into its children (if necessary) to make
-#' sure the right id is returned. Otherise, ordering of tokens might not be
+#' sure the right id is returned. Otherwise, ordering of tokens might not be
 #' preserved.
 #' @param direction Derived from `after`. `1` if `after = TRUE`, `-1` otherwise.
 #' @param candidates The `pos_ids` of the candidates that origin from other

R/transform-files.R

@@ -167,7 +167,7 @@ apply_transformers <- function(pd_nested, transformers) {
 
 
 
-#' Check whether a roundtip verification can be carried out
+#' Check whether a roundtrip verification can be carried out
 #'
 #' If scope was set to "line_breaks" or lower (compare [tidyverse_style()]),
 #' we can compare the expression before and after styling and return an error if

R/utils.R

@@ -29,7 +29,7 @@ add_spaces <- function(n) {
 #' Invoke a system command
 #'
 #' Wraps a system command into [shell()] or [system()], depending on the
-#' os.
+#' operating system.
 #' @param sys_call The call to be executed.
 #' @param ... Arguments passed to [shell()] or [system()].
 calls_sys <- function(sys_call, ...) {