xref and doctest for regexmatch and occursin (#49911)

JuliaLang · May 22, 2023 · 3b84b08 · 3b84b08
1 parent a6ad9ea
commit 3b84b08
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/base/regex.jl b/base/regex.jl
@@ -167,7 +167,7 @@ abstract type AbstractMatch end
 """
     RegexMatch <: AbstractMatch
 
-A type representing a single match to a `Regex` found in a string.
+A type representing a single match to a [`Regex`](@ref) found in a string.
 Typically created from the [`match`](@ref) function.
 
 The `match` field stores the substring of the entire matched string.

diff --git a/base/strings/search.jl b/base/strings/search.jl
@@ -709,6 +709,17 @@ The returned function is of type `Base.Fix2{typeof(occursin)}`.
 
 !!! compat "Julia 1.6"
     This method requires Julia 1.6 or later.
+
+# Examples
+```jldoctest
+julia> search_f = occursin("JuliaLang is a programming language");
+
+julia> search_f("JuliaLang")
+true
+
+julia> search_f("Python")
+false
+```
 """
 occursin(haystack) = Base.Fix2(occursin, haystack)