From: Bénédikt Tran <10796600+picnixz@users.noreply.github.com>
Date: Sun, 23 Jun 2024 16:02:24 +0000 (+0200)
Subject: [3.12] gh-119960: Add information about regex flags in re module functions (GH-119978... 
X-Git-Tag: v3.12.5~181
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=32d43e5fa25c6d4a82bfc635e4704dda6cc34afc;p=thirdparty%2FPython%2Fcpython.git

[3.12] gh-119960: Add information about regex flags in re module functions (GH-119978) (#120908)

gh-119960: Add information about regex flags in re module functions (#119978)

(cherry picked from commit a86e6255c371e14cab8680dee979a7393b339ce5)

Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
---

diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index 00eafda664af..813afcc483a2 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -911,6 +911,10 @@ Functions
    ``None`` if no position in the string matches the pattern; note that this is
    different from finding a zero-length match at some point in the string.
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
 
 .. function:: match(pattern, string, flags=0)
 
@@ -925,6 +929,10 @@ Functions
    If you want to locate a match anywhere in *string*, use :func:`search`
    instead (see also :ref:`search-vs-match`).
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
 
 .. function:: fullmatch(pattern, string, flags=0)
 
@@ -932,6 +940,10 @@ Functions
    corresponding :class:`~re.Match`.  Return ``None`` if the string does not match
    the pattern; note that this is different from a zero-length match.
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
    .. versionadded:: 3.4
 
 
@@ -974,6 +986,10 @@ Functions
       >>> re.split(r'(\W*)', '...words...')
       ['', '...', '', '', 'w', '', 'o', '', 'r', '', 'd', '', 's', '...', '', '', '']
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
    .. versionchanged:: 3.1
       Added the optional flags argument.
 
@@ -999,6 +1015,10 @@ Functions
       >>> re.findall(r'(\w+)=(\d+)', 'set width=20 and height=10')
       [('width', '20'), ('height', '10')]
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
    .. versionchanged:: 3.7
       Non-empty matches can now start just after a previous empty match.
 
@@ -1010,6 +1030,10 @@ Functions
    is scanned left-to-right, and matches are returned in the order found.  Empty
    matches are included in the result.
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
    .. versionchanged:: 3.7
       Non-empty matches can now start just after a previous empty match.
 
@@ -1065,6 +1089,10 @@ Functions
    character ``'0'``.  The backreference ``\g<0>`` substitutes in the entire
    substring matched by the RE.
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
    .. versionchanged:: 3.1
       Added the optional flags argument.
 
@@ -1100,6 +1128,10 @@ Functions
    .. versionchanged:: 3.5
       Unmatched groups are replaced with an empty string.
 
+   The expression's behaviour can be modified by specifying a *flags* value.
+   Values can be any of the `flags`_ variables, combined using bitwise OR
+   (the ``|`` operator).
+
 
 .. function:: escape(pattern)