]> granicus.if.org Git - python/commitdiff
bpo-26656: Improve re.compile documentation (GH-3211)
authorHenk-Jaap Wagenaar <wagenaarhenkjaap@gmail.com>
Mon, 28 Aug 2017 05:41:20 +0000 (06:41 +0100)
committerMariatta <Mariatta@users.noreply.github.com>
Mon, 28 Aug 2017 05:41:20 +0000 (22:41 -0700)
- Link to the regular expressions object documentation
- Clarify that it can be used with more than the two methods currently stated.

Doc/library/re.rst

index 0b9d9755f30ec658a068f4415edd24a376dc54a1..138e7d87996be83355c3946041313ebd24cac5ad 100644 (file)
@@ -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