Skip to content

Commit a9760eb

Browse files
committed
Improve titles & reference index
1 parent 990bc33 commit a9760eb

File tree

6 files changed

+16
-13
lines changed

6 files changed

+16
-13
lines changed

R/detect.R

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,10 @@ str_detect <- function(string, pattern, negate = FALSE) {
5454
)
5555
}
5656

57-
#' Detect the presence or absence of a pattern at the beginning or end of a
58-
#' string.
57+
#' Detect the presence/absence of a match at the beginning/end
5958
#'
60-
#' Vectorised over `string` and `pattern`.
59+
#' `str_starts()` and `str_ends()` are special cases of [str_detect()] that
60+
#' only match at the beginning or end of a string, respectively.
6161
#'
6262
#' @inheritParams str_detect
6363
#' @param pattern Pattern with which the string starts or ends.
@@ -111,7 +111,7 @@ str_ends <- function(string, pattern, negate = FALSE) {
111111
)
112112
}
113113

114-
#' Detect a pattern in the same way as `SQL`'s `LIKE` operator.
114+
#' Detect a pattern in the same way as `SQL`'s `LIKE` operator
115115
#'
116116
#' @description
117117
#' `str_like()` follows the conventions of the SQL `LIKE` operator:

R/locate.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ str_locate_all <- function(string, pattern) {
5858
}
5959

6060

61-
#' Switch location of matches to location of non-matches.
61+
#' Switch location of matches to location of non-matches
6262
#'
6363
#' Invert a matrix of match locations to match the opposite of what was
6464
#' previously matched.

_pkgdown.yml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,21 @@ reference:
6161
- str_equal
6262
- case
6363

64+
- title: Character based
65+
contents:
66+
- str_length
67+
- str_sub
68+
- str_trunc
69+
6470
- title: Other helpers
6571
contents:
6672
- invert_match
6773
- str_conv
6874
- str_dup
69-
- str_length
7075
- str_like
7176
- str_replace_na
72-
- str_trunc
7377
- str_unique
7478
- str_view
75-
- str_sub
7679
- word
7780

7881
- title: Bundled data

man/invert_match.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/str_like.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/str_starts.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)