diff options
| author | Henk-Jaap Wagenaar <wagenaarhenkjaap@gmail.com> | 2017-08-28 05:41:20 (GMT) |
|---|---|---|
| committer | Mariatta <Mariatta@users.noreply.github.com> | 2017-08-28 05:41:20 (GMT) |
| commit | ed94a8b2851914bcda3a77b28b25517b8baa91e6 (patch) | |
| tree | 3565e34260bce05495d20693c5c63d39ccd5d03d /Doc/library/re.rst | |
| parent | 998f4966bf0c591f3e8b3d07eccad7501f60f524 (diff) | |
| download | cpython-ed94a8b2851914bcda3a77b28b25517b8baa91e6.zip cpython-ed94a8b2851914bcda3a77b28b25517b8baa91e6.tar.gz cpython-ed94a8b2851914bcda3a77b28b25517b8baa91e6.tar.bz2 | |
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.
Diffstat (limited to 'Doc/library/re.rst')
| -rw-r--r-- | Doc/library/re.rst | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/Doc/library/re.rst b/Doc/library/re.rst index 0b9d975..138e7d8 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 |