Skip to content

Commit

Permalink
consistent {} notation for packages in docs (#2237)
Browse files Browse the repository at this point in the history
  • Loading branch information
MichaelChirico authored Oct 13, 2023
1 parent dfc51ea commit 8f8f151
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion R/backport_linter.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#'
#' @param r_version Minimum R version to test for compatibility
#' @param except Character vector of functions to be excluded from linting.
#' Use this to list explicitly defined backports, e.g. those imported from the {backports} package or manually
#' Use this to list explicitly defined backports, e.g. those imported from the `{backports}` package or manually
#' defined in your package.
#'
#' @examples
Expand Down
2 changes: 1 addition & 1 deletion R/scalar_in_linter.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Block usage like x %in% "a"
#'
#' `vector %in% set` is appropriate for matching a vector to a set, but if
#' that set has size 1, `==` is more appropriate. `%chin%` from `data.table`
#' that set has size 1, `==` is more appropriate. `%chin%` from `{data.table}`
#' is matched as well.
#'
#' `scalar %in% vector` is OK, because the alternative (`any(vector == scalar)`)
Expand Down
2 changes: 1 addition & 1 deletion R/seq_linter.R
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
#' `1:NROW(...)` and `1:NCOL(...)` expressions in base-R, or their usage in
#' conjunction with `seq()` (e.g., `seq(length(...))`, `seq(nrow(...))`, etc.).
#'
#' Additionally, it checks for `1:n()` (from dplyr) and `1:.N` (from data.table).
#' Additionally, it checks for `1:n()` (from `{dplyr}`) and `1:.N` (from `{data.table}`).
#'
#' These often cause bugs when the right-hand side is zero.
#' It is safer to use [base::seq_len()] or [base::seq_along()] instead.
Expand Down
2 changes: 1 addition & 1 deletion R/xp_utils.R
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ xp_find_location <- function(xml, xpath) {

#' Strip XPath 2.0-style comments from an XPath
#'
#' xml2 uses XPath 1.0, which has no support for comments. But comments are
#' `{xml2}` uses XPath 1.0, which has no support for comments. But comments are
#' useful in a codebase with as many XPaths as we maintain, so we fudge our
#' way to XPath 2.0-ish support by writing this simple function to remove comments.
#'
Expand Down
2 changes: 1 addition & 1 deletion man/backport_linter.Rd

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

2 changes: 1 addition & 1 deletion man/scalar_in_linter.Rd

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

2 changes: 1 addition & 1 deletion man/seq_linter.Rd

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

0 comments on commit 8f8f151

Please sign in to comment.