summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorwulmer <wulmer@users.noreply.github.com>2023-07-22 15:44:44 (GMT)
committerGitHub <noreply@github.com>2023-07-22 15:44:44 (GMT)
commit149748ea4f552e6fe43a1d6d69bd65910a7c4813 (patch)
treef314673a79e5da5dfbb3c9ff60d55d160051f964
parent5e4af2a3e90d78fdf6a4cc42e0472576b1f2b975 (diff)
downloadcpython-149748ea4f552e6fe43a1d6d69bd65910a7c4813.zip
cpython-149748ea4f552e6fe43a1d6d69bd65910a7c4813.tar.gz
cpython-149748ea4f552e6fe43a1d6d69bd65910a7c4813.tar.bz2
Fix Sphinx warnings in `re` module docs (#107044)
-rw-r--r--Doc/library/re.rst23
-rw-r--r--Doc/tools/.nitignore1
2 files changed, 18 insertions, 6 deletions
diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index b7510b9..629ee47 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -501,6 +501,8 @@ The special characters are:
in the ASCII range (``b'\x00'``-``b'\x7f'``).
+.. _re-special-sequences:
+
The special sequences consist of ``'\'`` and a character from the list below.
If the ordinary character is not an ASCII digit or an ASCII letter, then the
resulting RE will match the second character. For example, ``\$`` matches the
@@ -779,6 +781,17 @@ Flags
Corresponds to the inline flag ``(?s)``.
+.. data:: U
+ UNICODE
+
+ In Python 2, this flag made :ref:`special sequences <re-special-sequences>`
+ include Unicode characters in matches. Since Python 3, Unicode characters
+ are matched by default.
+
+ See :const:`A` for restricting matching on ASCII characters instead.
+
+ This flag is only kept for backward compatibility.
+
.. data:: X
VERBOSE
@@ -1520,14 +1533,14 @@ Simulating scanf()
.. index:: single: scanf()
-Python does not currently have an equivalent to :c:func:`scanf`. Regular
+Python does not currently have an equivalent to :c:func:`!scanf`. Regular
expressions are generally more powerful, though also more verbose, than
-:c:func:`scanf` format strings. The table below offers some more-or-less
-equivalent mappings between :c:func:`scanf` format tokens and regular
+:c:func:`!scanf` format strings. The table below offers some more-or-less
+equivalent mappings between :c:func:`!scanf` format tokens and regular
expressions.
+--------------------------------+---------------------------------------------+
-| :c:func:`scanf` Token | Regular Expression |
+| :c:func:`!scanf` Token | Regular Expression |
+================================+=============================================+
| ``%c`` | ``.`` |
+--------------------------------+---------------------------------------------+
@@ -1552,7 +1565,7 @@ To extract the filename and numbers from a string like ::
/usr/sbin/sendmail - 0 errors, 4 warnings
-you would use a :c:func:`scanf` format like ::
+you would use a :c:func:`!scanf` format like ::
%s - %d errors, %d warnings
diff --git a/Doc/tools/.nitignore b/Doc/tools/.nitignore
index ca6f32c..87157f0 100644
--- a/Doc/tools/.nitignore
+++ b/Doc/tools/.nitignore
@@ -174,7 +174,6 @@ Doc/library/pyclbr.rst
Doc/library/pydoc.rst
Doc/library/pyexpat.rst
Doc/library/random.rst
-Doc/library/re.rst
Doc/library/readline.rst
Doc/library/reprlib.rst
Doc/library/resource.rst