Skip to content

Commit

Permalink
Use list in roxygen doc
Browse files Browse the repository at this point in the history
  • Loading branch information
salim-b committed Mar 13, 2024
1 parent a4b54da commit 229993a
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 10 deletions.
10 changes: 5 additions & 5 deletions R/brace_linter.R
Original file line number Diff line number Diff line change
Expand Up @@ -11,11 +11,11 @@
#' - Function bodies are wrapped in curly braces.
#'
#' @param allow_single_line If `TRUE`, allow an open and closed curly pair on the same line.
#' @param function_braces Character string specifying whether to require function bodies to be wrapped in curly braces.
#' `"always"` requires braces for all function definitions, including inline functions.
#' `"not_inline"` requires braces when a function body does not start on the same line as its header.
#' `"multi_line"`, the default, requires braces when a function definition spans multiple lines.
#' `"never"` never requires braces in function bodies.
#' @param function_braces Whether to require function bodies to be wrapped in curly braces. One of
#' - `"always"` to require braces for all function definitions, including inline functions,
#' - `"not_inline"` to require braces when a function body does not start on the same line as its signature,
#' - `"multi_line"` (the default) to require braces when a function definition spans multiple lines,
#' - `"never"` to never require braces in function bodies.
#'
#' @examples
#' # will produce lints
Expand Down
12 changes: 7 additions & 5 deletions man/brace_linter.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 229993a

Please sign in to comment.