some manual tidying.

Author: lorenzwalthert

R/indent.R

@@ -173,7 +173,7 @@ needs_indention_one <- function(pd, potential_trigger) {
 #' Set the multi-line column
 #'
 #' Sets the column `multi_line` in `pd` by checking row-wise whether any child
-#'   of a token is a multi-line token.
+#' of a token is a multi-line token.
 #' @param pd A parse table.
 #' @importFrom purrr map_lgl
 set_multi_line <- function(pd) {

R/nest.R

@@ -1,8 +1,7 @@
 #' Obtain a nested parse table from a character vector
 #'
 #' Parses `text` to a flat parse table and subsequently changes its
-#'   representation into a nested parse table with
-#'   [nest_parse_data()].
+#' representation into a nested parse table with [nest_parse_data()].
 #' @param text A character vector to parse.
 #' @return A nested parse table. See [tokenize()] for details on the columns
 #'   of the parse table.
@@ -24,7 +23,7 @@ compute_parse_data_nested <- function(text) {
 #' Enhance the mapping of text to the token "SPECIAL"
 #'
 #' Map text corresponding to the token "SPECIAL" to a (more) unique token
-#'   description.
+#' description.
 #' @param pd A parse table.
 enhance_mapping_special <- function(pd) {
   pipes <- pd$token == "SPECIAL" & pd$text == "%>%"
@@ -102,11 +101,11 @@ set_spaces <- function(spaces_after_prefix, force_one) {
 #' Nest a flat parse table
 #'
 #' `nest_parse_data` groups `pd_flat` into a parse table with tokens that are
-#'   a parent to other tokens (called internal) and such that are not (called
-#'   child). Then, the token in child are joined to their parents in internal
-#'   and all token information of the children is nested into a column "child".
-#'   This is done recursively until we are only left with a nested tibble that
-#'   contains one row: The nested parse table.
+#'  a parent to other tokens (called internal) and such that are not (called
+#'  child). Then, the token in child are joined to their parents in internal
+#'  and all token information of the children is nested into a column "child".
+#'  This is done recursively until we are only left with a nested tibble that
+#'  contains one row: The nested parse table.
 #' @param pd_flat A flat parse table including both terminals and non-terminals.
 #' @seealso [compute_parse_data_nested()]
 #' @return A nested parse table.
@@ -136,7 +135,7 @@ nest_parse_data <- function(pd_flat) {
 #' Combine child and internal child
 #'
 #' Binds two parse tables together and arranges them so that the tokens are in
-#'   the correct order.
+#' the correct order.
 #' @param child A parse table or `NULL`.
 #' @param internal_child A parse table or `NULL`.
 #' @details Essentially, this is a wrapper around [dplyr::bind_rows()], but

R/nested_to_tree.R

@@ -15,7 +15,7 @@ create_tree <- function(text, structure_only = FALSE) {
 #' Convert a nested tibble into a node tree
 #'
 #' This function is convenient to display all nesting levels of a nested tibble
-#'   at once.
+#' at once.
 #' @param pd_nested A nested tibble.
 #' @param structure_only Whether or not create a tree that represents the
 #'   structure of the expression without any information on the tokens. Useful

R/reindent.R

@@ -5,7 +5,6 @@
 #' @name update_indention_ref
 NULL
 
-
 #' @describeIn update_indention_ref Updates the reference pos_id for all
 #'   tokens in `pd_nested` if `pd_nested` contains a function call. Tokens that
 #'   start on the same line as the opening parenthesis, are not themselves
@@ -111,9 +110,6 @@ apply_ref_indention_one <- function(flattened_pd, target_token) {
   flattened_pd
 }
 
-
-
-
 #' Set indention of tokens that match regex
 #'
 #' Force the level of indention of tokens whose text matches a regular

R/relevel.R

@@ -4,11 +4,11 @@
 #' Flatten some token in the nested parse table based on operators
 #'
 #' Certain tokens are not placed optimally in the nested parse data with
-#'   [compute_parse_data_nested()]. For example, the token of arithmetic
-#'   operations 1 + 1 + 1 should all be on the same level of nesting since
-#'   the indention is the same for all but the first two terminals. Setting the
-#'   indention correctly is easier to achieve if they are put on the same level
-#'   of nesting.
+#' [compute_parse_data_nested()]. For example, the token of arithmetic
+#' operations 1 + 1 + 1 should all be on the same level of nesting since the
+#' indention is the same for all but the first two terminals. Setting the
+#' indention correctly is easier to achieve if they are put on the same level of
+#' nesting.
 #' @param pd_nested A nested parse table to partially flatten.
 flatten_operators <- function(pd_nested) {
   pd_nested %>%
@@ -17,9 +17,9 @@ flatten_operators <- function(pd_nested) {
 
 #' Flatten one level of nesting with its child
 #'
-#' Flattening is done in two ways. We can flatten a parse table by moving
-#'   the left hand token of an operator one level up. Or doing that with the
-#'   right hand token.
+#' Flattening is done in two ways. We can flatten a parse table by moving the
+#' left hand token of an operator one level up. Or doing that with the right
+#' hand token.
 #' @param pd_nested A nested parse table.
 #' @include token-define.R
 flatten_operators_one <- function(pd_nested) {

R/rules-spacing.R

@@ -154,10 +154,10 @@ remove_space_before_comma <- function(pd_flat) {
 #' Set space between levels of nesting
 #'
 #' With the nested approach, certain rules do not have an effect anymore because
-#'   of the nature of the nested structure. Setting spacing before curly
-#'   brackets in for / if / while statements and function declarations will be
-#'   such a case since a curly bracket is always at the first position in a
-#'   parse table, so spacing cannot be set after the previous token.
+#' of the nature of the nested structure. Setting spacing before curly
+#' brackets in for / if / while statements and function declarations will be
+#' such a case since a curly bracket is always at the first position in a parse
+#' table, so spacing cannot be set after the previous token.
 #' @param pd_flat A flat parse table.
 set_space_between_levels <- function(pd_flat) {
   if (pd_flat$token[1] %in% c("FUNCTION", "IF", "WHILE")) {
@@ -173,9 +173,9 @@ set_space_between_levels <- function(pd_flat) {
 #' Start comments with a space
 #'
 #' Forces comments to start with a space, that is, after the regular expression
-#'   "^#+'*", at least one space must follow if the comment is *non-empty*, i.e
-#'   there is not just spaces within the comment. Multiple spaces may be legit
-#'   for indention in some situations.
+#' "^#+'*", at least one space must follow if the comment is *non-empty*, i.e
+#' there is not just spaces within the comment. Multiple spaces may be legit for
+#' indention in some situations.
 #' @param pd A parse table.
 #' @param force_one Whether or not to force one space or allow multiple spaces
 #'   after the regex "^#+'*".

R/styler.R

@@ -1,14 +1,14 @@
 #' Non-invasive pretty printing of R code
 #'
 #' styler allows you to format .R files, packages or entire R source trees
-#'  according to a style guide.
-#'  The following functions can be used for styling:
-#'  * [style_text()] to style a character vector.
-#'  * [style_file()] to style a single .R file.
-#'  * [style_dir()] to style all .R files in a directory.
-#'  * [style_pkg()] to style the source files of an R package.
-#'  * [styler_addins] (RStudio Addins) to style either selected code or the
-#'  active file.
+#' according to a style guide.
+#' The following functions can be used for styling:
+#' * [style_text()] to style a character vector.
+#' * [style_file()] to style a single .R file.
+#' * [style_dir()] to style all .R files in a directory.
+#' * [style_pkg()] to style the source files of an R package.
+#' * [styler_addins] (RStudio Addins) to style either selected code or the
+#' active file.
 #' @examples
 #' style_text("call( 1)")
 #' style_text("1    + 1", strict = FALSE)

R/token-define.R

@@ -37,7 +37,7 @@ lookup_tokens <- function() {
   token
 }
 
-#' lookup which new tokens were created from "SPECIAL"
+#' Lookup which new tokens were created from "SPECIAL"
 #'
 #' @param regex A regular expression pattern to search for.
 #' @importFrom purrr map_chr

R/unindent.R

@@ -1,7 +1,7 @@
 #' Unindent a child if necessary
 #'
-#' check whether any of the children of `pd` has `token` on the same line as
-#'   the closing `token` of pd. If so, unindent that token.
+#' check whether any of the children of `pd` has `token` on the same line as the
+#' closing `token` of pd. If so, unindent that token.
 #' @inheritParams unindent_child
 #' @importFrom purrr map
 #' @importFrom rlang seq2

R/visit.R

@@ -82,10 +82,9 @@ context_to_terminals <- function(pd_nested,
 #' Update the a parse table given outer context
 #'
 #' `outer_lag_newlines` are added to the first token in `pd`,
-#' `outer_indent` is added to all tokens in `pd`, `outer_spaces` is added to
-#' the last token in `pd`. [context_to_terminals()] calls this function
-#' repeatedly, which means the propagation of the parse information to the
-#' terminal tokens.
+#' `outer_indent` is added to all tokens in `pd`, `outer_spaces` is added to the
+#' last token in `pd`. [context_to_terminals()] calls this function repeatedly,
+#' which means the propagation of the parse information to the terminal tokens.
 #' @param pd_nested A nested parse table.
 #' @param outer_lag_newlines The lag_newlines to be propagated inwards.
 #' @param outer_indent The indention depth to be propagated inwards.
@@ -125,16 +124,16 @@ extract_terminals <- function(pd_nested) {
 #' possible to compute the exact position a token will have (line and column)
 #' when it will be serialized.
 #' @details
-#' Since we have only terminal tokens now, the line on which a token
-#' starts we also be the line on which it ends. We call `line1` the line on
-#' which the token starts. `line1` has the same meaning as `line1` that can be
-#' found in a flat parse table (see [tokenize()]), just that the `line1`
-#' created by `enrich_terminals()` is the updated version of the former
-#' `line1`. The same applies for `col1` and `col2`. Note that this function
-#' does remove the columns `indent` and `spaces.` All information of the former
-#' is stored in `lag_spaces` now. The later was removed because it is redundant
-#' after adding the column `lag_spaces`, which is more convenient to work with,
-#' in particular when serializing the parse table.
+#' Since we have only terminal tokens now, the line on which a token starts we
+#' also be the line on which it ends. We call `line1` the line on which the
+#' token starts. `line1` has the same meaning as `line1` that can be found in a
+#' flat parse table (see [tokenize()]), just that the `line1` created by
+#' `enrich_terminals()` is the updated version of the former `line1`. The same
+#' applies for `col1` and `col2`. Note that this function does remove the
+#' columns `indent` and `spaces.` All information of the former is stored in
+#' `lag_spaces` now. The later was removed because it is redundant after adding
+#' the column `lag_spaces`, which is more convenient to work with, in particular
+#' when serializing the parse table.
 #' @inheritParams choose_indention
 enrich_terminals <- function(flattened_pd, use_raw_indention = FALSE) {
   flattened_pd$lag_spaces <- lag(flattened_pd$spaces, default = 0L)