document use (and risk) of $N special capture group variables (#3979) #4023
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
|
I'd add a note about nilable |
luislavena
reviewed
Feb 13, 2017
src/regex.cr
Outdated
| # ``` | ||
| # /(spice)(s)?/.match("spice") # => #<Regex::MatchData "spice" 1:"spice" 2:nil> | ||
| # $1 # => "spice" | ||
| # $2 # => Exception |
There was a problem hiding this comment.
The best comment for exception will be # raises Exception, following the other inline examples (see #3820)
There was a problem hiding this comment.
I'd also document the exception type raised.
src/regex.cr
Outdated
| # ``` | ||
| # | ||
| # This can be mitigated by using the nilable version of the above: $N?, | ||
| # (e.g., $1? $2?, $3?, ...). Changing the above to use `$2?` isntead of `$2` |
|
LGTM. As soon as the typo is fixed, let us know and we'll merge. Thanks! |
|
Thanks, @karlseguin! |
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.
addresses issue #3979