add Regex documentation
#28703
Merged
add Regex documentation
#28703
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
add `Regex` documentation. (JuliaLang#26919)
dont link to regex docs
waldyrious
reviewed
Aug 17, 2018
base/regex.jl
Outdated
| """ | ||
| Regex(pattern[, flags]) | ||
|
|
||
| A type representing a regular expression. `Regex`-objects can be used to match strings |
There was a problem hiding this comment.
Why the hyphen? I don't think it's warranted, and in any case this format is inconsistent with the one used just three lines below.
There was a problem hiding this comment.
thanks for the comment!
waldyrious
reviewed
Aug 17, 2018
base/regex.jl
Outdated
| A type representing a regular expression. `Regex`-objects can be used to match strings | ||
| with [`match`](@ref) or [`matchall`](@ref). | ||
|
|
||
| `Regex` objects can be created using the [`@r_str`](@ref) string-macro. The |
There was a problem hiding this comment.
Here too the hyphen feels odd to me. I'd simply write "string macro" (also two lines below).
removed hyphens
waldyrious
reviewed
Aug 17, 2018
base/regex.jl
Outdated
|
|
||
| `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. |
There was a problem hiding this comment.
You missed the hyphen here :)
i seem to like hyphens....
fredrikekre
reviewed
Aug 18, 2018
base/regex.jl
Outdated
| Regex(pattern[, flags]) | ||
|
|
||
| A type representing a regular expression. `Regex` objects can be used to match strings | ||
| with [`match`](@ref) or [`matchall`](@ref). |
There was a problem hiding this comment.
matchall does not exist anymore.
removed ref to `matchall`
fredrikekre
added
docs
Merged
KristofferC
reviewed
Aug 19, 2018
| @@ -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. | |||
|
I had that reference in an earlier commit, but it seems like the ref needs to be added to Thats the reason for ci failures |
|
Heh, alright lets just remove it then :) |
KristofferC
pushed a commit
that referenced
this pull request
Aug 23, 2018
staticfloat
pushed a commit
that referenced
this pull request
Aug 24, 2018
KristofferC
pushed a commit
that referenced
this pull request
Sep 8, 2018
KristofferC
pushed a commit
that referenced
this pull request
Sep 8, 2018
KristofferC
pushed a commit
that referenced
this pull request
Feb 11, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
add
Regexdocumentation. (#26919)