godotengine / godotengine/godot-docs

RegEx Documentation lacks defined Modes

Open
#4,943 0 comments 4 reactions 0 assignees View on GitHub
area:class reference enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

Within the documentation for the RegEx class, there is no mention of flags, conditions, or modes to alter how a Regex pattern functions (ie: case insensitive mode, or multi-line mode). The only way to use these different modes is by using the `(?%)` format *(substituting the % for the specified modes). It is difficult to find this functionality without prior knowledge within Godot and in the PCRE2 documentation.

I believe there should be an addition inside Godot's RegEx class documentation demonstrating how to use modes to avoid this confusion for people new to Regex or unfamiliar with this way to declare modes.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.