Skip to content

Commit a7b47ff

Browse files
Don't describe initializers in the exported function.
1 parent e492134 commit a7b47ff

File tree

3 files changed

+12
-40
lines changed

3 files changed

+12
-40
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Package: styler
2-
Title: Non-Invasive Pretty Printing of R code
2+
Title: Non-Invasive Pretty Printing of R Code
33
Version: 1.0.0
44
Authors@R: c(person("Kirill", "Müller", role = c("aut"), email = "[email protected]"),
55
person("Lorenz", "Walthert", role = c("cre", "aut"), email = "[email protected]"))

R/initialize.R

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@ initialize_default_attributes <- function(pd_flat) {
2222
init_pd
2323
}
2424

25-
#' @describeIn initialize_default_attributes Initializes `newlines` and `lag_newlines`.
25+
#' Initialize attributes
26+
#'
27+
#' @name initialize_attributes
28+
NULL
29+
30+
#' @describeIn initialize_attributes Initializes `newlines` and `lag_newlines`.
2631
initialize_newlines <- function(pd_flat) {
2732
pd_flat$line3 <- lead(pd_flat$line1, default = tail(pd_flat$line2, 1))
2833
pd_flat$newlines <- pd_flat$line3 - pd_flat$line2
@@ -31,7 +36,7 @@ initialize_newlines <- function(pd_flat) {
3136
pd_flat
3237
}
3338

34-
#' @describeIn initialize_default_attributes Initializes `spaces`.
39+
#' @describeIn initialize_attributes Initializes `spaces`.
3540
initialize_spaces <- function(pd_flat) {
3641
pd_flat$col3 <- lead(pd_flat$col1, default = tail(pd_flat$col2, 1) + 1L)
3742
pd_flat$col2_nl <- if_else(pd_flat$newlines > 0L,
@@ -48,7 +53,7 @@ remove_attributes <- function(pd_flat, attributes) {
4853
pd_flat
4954
}
5055

51-
#' @describeIn initialize_default_attributes Initializes `multi_line`.
56+
#' @describeIn initialize_attributes Initializes `multi_line`.
5257
initialize_multi_line <- function(pd_flat) {
5358
nrow <- nrow(pd_flat)
5459
pd_flat$multi_line <- if_else(pd_flat$terminal,
@@ -58,21 +63,21 @@ initialize_multi_line <- function(pd_flat) {
5863
pd_flat
5964
}
6065

61-
#' @describeIn initialize_default_attributes Initializes `indention_ref_ind`.
66+
#' @describeIn initialize_attributes Initializes `indention_ref_ind`.
6267
initialize_indention_ref_pos_id <- function(pd_flat) {
6368
pd_flat$indention_ref_pos_id <- NA
6469
pd_flat
6570
}
6671

67-
#' @describeIn initialize_default_attributes Initializes `indent`.
72+
#' @describeIn initialize_attributes Initializes `indent`.
6873
initialize_indent <- function(pd_flat) {
6974
if (!("indent" %in% names(pd_flat))) {
7075
pd_flat$indent <- 0
7176
}
7277
pd_flat
7378
}
7479

75-
#' @describeIn initialize_default_attributes validates the parse data.
80+
#' @describeIn initialize_attributes validates the parse data.
7681
validate_parse_data <- function(pd_flat) {
7782
if (any(pd_flat$spaces < 0L)) {
7883
stop("Invalid parse data")

man/initialize_default_attributes.Rd

Lines changed: 0 additions & 33 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)