]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-101699: Explain using Match.expand with \g<0> (GH-101701)
authorStevoisiak <S.Vascellaro@gmail.com>
Sat, 17 Feb 2024 08:33:28 +0000 (03:33 -0500)
committerGitHub <noreply@github.com>
Sat, 17 Feb 2024 08:33:28 +0000 (08:33 +0000)
Update documentation for re library to explain that a backreference `\g<0>` is
expanded to the entire string when using Match.expand().
Note that numeric backreferences to group 0 (`\0`) are not supported.

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
Doc/library/re.rst

index a5bd5c73f2fac717cf19572fdcdc7bef4a5727f1..0336121c2bc631da2b67a6a23b3ff774549189fd 100644 (file)
@@ -1344,7 +1344,8 @@ when there is no match, you can test whether there was a match with a simple
    Escapes such as ``\n`` are converted to the appropriate characters,
    and numeric backreferences (``\1``, ``\2``) and named backreferences
    (``\g<1>``, ``\g<name>``) are replaced by the contents of the
-   corresponding group.
+   corresponding group. The backreference ``\g<0>`` will be
+   replaced by the entire match.
 
    .. versionchanged:: 3.5
       Unmatched groups are replaced with an empty string.