Skip to content

Commit d27b5f3

Browse files
authored
Update docstrings.jl
1 parent c369d18 commit d27b5f3

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

src/docstrings.jl

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,14 @@
11
const docstring_str_detect =
22
"""
3-
str_detect(string::String, pattern::Union{String, Regex})
3+
str_detect(string::String, pattern::Union{String, Regex}; overlap::Bool=false)
44
55
Determine if a string contains a certain pattern.
66
77
# Arguments
88
- `string`: The string to check.
9-
pattern: A string or a regular expression to find within the string.
9+
- `pattern`: A string or a regular expression to find within the string.
10+
- `overlap`: Whether the pattern can overlap (default false)
11+
1012
The pattern can include special logic:
1113
1214
Use | to represent "or" (e.g., "red|blue" matches any string that contains "red" or "blue").
@@ -904,4 +906,4 @@ julia> str_trunc("Short", 10)
904906
julia> str_trunc("This is a long string that needs to be truncated", 20, side = "right", ellipsis = "--")
905907
"This is a long str--"
906908
```
907-
"""
909+
"""

0 commit comments

Comments
 (0)