[Python-checkins] bpo-26656: Improve re.compile documentation (GH-3211)
Mariatta
webhook-mailer at python.org
Mon Aug 28 01:41:22 EDT 2017
https://github.com/python/cpython/commit/ed94a8b2851914bcda3a77b28b25517b8baa91e6
commit: ed94a8b2851914bcda3a77b28b25517b8baa91e6
branch: master
author: Henk-Jaap Wagenaar <wagenaarhenkjaap at gmail.com>
committer: Mariatta <Mariatta at users.noreply.github.com>
date: 2017-08-27T22:41:20-07:00
summary:
bpo-26656: Improve re.compile documentation (GH-3211)
- Link to the regular expressions object documentation
- Clarify that it can be used with more than the two methods currently stated.
files:
M Doc/library/re.rst
diff --git a/Doc/library/re.rst b/Doc/library/re.rst
index 0b9d9755f30..138e7d87996 100644
--- a/Doc/library/re.rst
+++ b/Doc/library/re.rst
@@ -490,9 +490,10 @@ form.
.. function:: compile(pattern, flags=0)
- Compile a regular expression pattern into a regular expression object, which
- can be used for matching using its :func:`~regex.match` and
- :func:`~regex.search` methods, described below.
+ Compile a regular expression pattern into a :ref:`regular expression object
+ <re-objects>`, which can be used for matching using its
+ :func:`~regex.match`, :func:`~regex.search` and other methods, described
+ below.
The expression's behaviour can be modified by specifying a *flags* value.
Values can be any of the following variables, combined using bitwise OR (the
More information about the Python-checkins
mailing list