Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add Regex documentation #28703

Merged
merged 7 commits into from
Aug 23, 2018
Merged

add Regex documentation #28703

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
e92679c
Update regex.jl
ChristianKurz Aug 16, 2018
a0019ad
Update regex.jl
ChristianKurz Aug 17, 2018
56fe6a0
Update regex.jl
ChristianKurz Aug 17, 2018
b8fffc6
Update regex.jl
ChristianKurz Aug 18, 2018
581a100
Update regex.jl
ChristianKurz Aug 18, 2018
a68c2fb
Update regex.jl
KristofferC Aug 20, 2018
9ad0e08
undo
KristofferC Aug 20, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions base/regex.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,16 @@ include("pcre.jl")
const DEFAULT_COMPILER_OPTS = PCRE.UTF | PCRE.NO_UTF_CHECK | PCRE.ALT_BSUX | PCRE.UCP
const DEFAULT_MATCH_OPTS = PCRE.NO_UTF_CHECK

"""
Regex(pattern[, flags])

A type representing a regular expression. `Regex` objects can be used to match strings
with [`match`](@ref).

`Regex` objects can be created using the [`@r_str`](@ref) string macro. The
`Regex(pattern[, flags])` constructor is usually used if the `pattern` string needs
to be interpolated. See the documentation of the string macro for details on flags.
"""
mutable struct Regex
pattern::String
compile_options::UInt32
Expand Down Expand Up @@ -81,6 +91,8 @@ listed after the ending quote, to change its behaviour:
`\\s`, `\\W`, `\\w`, etc. match based on Unicode character properties. With this option,
these sequences only match ASCII characters.

See `Regex` if interpolation is needed.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

[`Regex`](@ref)

maybe?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

pushed the update


# Examples
```jldoctest
julia> match(r"a+.*b+.*?d\$"ism, "Goodbye,\\nOh, angry,\\nBad world\\n")
Expand Down