Update Regex t:compile_option/0 to reflect :re #13643
Closed
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
sabiwara
commented
Jun 6, 2024
| @type re_option :: | ||
| @type nl_spec() :: :cr | :crlf | :lf | :anycrlf | :any | ||
|
|
||
| @type compile_option :: |
There was a problem hiding this comment.
Also renamed since it's been introduced in 1.17, and I think it's clearer + matches :re's.
There was a problem hiding this comment.
If it was introduced in 1.17.0, maybe we should remove them for now. Erlang said they will change the RE engine for OTP 28, so any of those options may no longer be supported in a year. So perhaps we should remove those for now and backport?
There was a problem hiding this comment.
Oh, do you think they'll break backwards compatibility?
This is a shame, these specs really help figuring out what the types are.
How about:
- keeping
compile_option :: termandrun_option :: termjust to make the intent and distinction clear - perhaps add a link to erlang's doc for options in typedoc
|
Note: to be backported if merged. |
|
Closing in favor of #13645 |
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.
Closes #13598.
Was caused by my PR.
Copied the spec from
:re.We can't just use
:retype directly because it has been exported only recently.