Skip to content

Commit bd016a0

Browse files
Fix docs where part of 'Description' ends up in 'Details' (#3024)
* init * remove styling change * more cases
1 parent 3df637d commit bd016a0

File tree

8 files changed

+5
-14
lines changed

8 files changed

+5
-14
lines changed

R/brace_linter.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
#' Brace linter
22
#'
33
#' Perform various style checks related to placement and spacing of curly braces:
4-
#'
54
#' - Opening curly braces are never on their own line and are always followed by a newline.
65
#' - Opening curly braces have a space before them.
76
#' - Closing curly braces are on their own line unless they are followed by an `else`.

R/library_call_linter.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
#' Library call linter
22
#'
33
#' This linter covers several rules related to [library()] calls:
4-
#'
54
#' - Enforce such calls to all be at the top of the script.
65
#' - Block usage of argument `character.only`, in particular
76
#' for loading packages in a loop.

R/object_length_linter.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
#'
33
#' Check that object names are not too long.
44
#' The length of an object name is defined as the length in characters, after removing extraneous parts:
5-
#'
65
#' * generic prefixes for implementations of S3 generics, e.g. `as.data.frame.my_class` has length 8.
76
#' * leading `.`, e.g. `.my_hidden_function` has length 18.
87
#' * "%%" for infix operators, e.g. `%my_op%` has length 5.

R/pipe_return_linter.R

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
#'
33
#' [return()] inside a magrittr pipeline does not actually execute `return()`
44
#' like you'd expect:
5-
#'
65
#' ```r
76
#' bad_usage <- function(x) {
87
#' x %>%

man/brace_linter.Rd

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

man/library_call_linter.Rd

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

man/object_length_linter.Rd

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

man/pipe_return_linter.Rd

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

0 commit comments

Comments
 (0)