From: Miss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Date: Wed, 5 Oct 2022 01:37:01 +0000 (-0700)
Subject: Add re.VERBOSE flag documentation example (GH-97678)
X-Git-Tag: v3.10.8~53
X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=24908f1f207f4642fc57ae79c69a3dcb0770a96a;p=thirdparty%2FPython%2Fcpython.git

Add re.VERBOSE flag documentation example (GH-97678)


The current re.VERBOSE documentation example leaves space for ambiguous
interpretation. One may read that spaces within the `(?:` token are
spaces inside the non-capturing group (such as `(?: )`). This patch
removes the ambiguity by including examples after the statement.
(cherry picked from commit 0ceafa7fa408b64377ea31dd5386152da19ef38a)

Co-authored-by: Athos Ribeiro <athoscribeiro@gmail.com>
---

diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index fd1224131221..e7d1f0560b2a 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -702,7 +702,8 @@ Flags
    more readable by allowing you to visually separate logical sections of the
    pattern and add comments. Whitespace within the pattern is ignored, except
    when in a character class, or when preceded by an unescaped backslash,
-   or within tokens like ``*?``, ``(?:`` or ``(?P<...>``.
+   or within tokens like ``*?``, ``(?:`` or ``(?P<...>``. For example, ``(? :``
+   and ``* ?`` are not allowed.
    When a line contains a ``#`` that is not in a character class and is not
    preceded by an unescaped backslash, all characters from the leftmost such
    ``#`` through the end of the line are ignored.