-
-
Notifications
You must be signed in to change notification settings - Fork 2.9k
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.
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
Improve RegEx documentation #2522
Comments
The regex module in Godot is based on PCRE2, but I don't know if there are specific caveats with regexes in Godot. |
I guess we could also link people to https://www.pcre.org/current/doc/html/pcre2pattern.html. |
Version 2.1 documentation (https://docs.godotengine.org/en/2.1/classes/class_regex.html) had a list of supported features:
Perhaps it could be copied into the 3.x documentation and modified, if necessary. If doing so, note that \* in bullet 5 should be * and \*? in bullet 7 should be *?, I believe. |
This closes godotengine/godot-docs#2522. (cherry picked from commit 5b78f5c)
The current documentation is okay as far as it goes, but in terms of how to write a regex, it simply states, "For a more in-depth look, you can easily find various tutorials and detailed explanations on the Internet." This is not good enough, because while most implementations of regex support *, ?, and other common patterns, the exact details vary between systems. Are (?R) groups supported? What metacharacters are available? Are matches multiline, are they case sensitive? Does . match newlines? Can we have at least some information on what Godot regexes actually are?
The text was updated successfully, but these errors were encountered: