Clarify rx parameter of compileall functions (#25857)

This commit is contained in:
Jean-Abou-Samra 2021-05-04 21:37:39 +02:00 committed by GitHub
parent 1add719516
commit 09490298d4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -166,9 +166,10 @@ Public functions
If *force* is true, modules are re-compiled even if the timestamps are up to
date.
If *rx* is given, its search method is called on the complete path to each
If *rx* is given, its ``search`` method is called on the complete path to each
file considered for compilation, and if it returns a true value, the file
is skipped.
is skipped. This can be used to exclude files matching a regular expression,
given as a :ref:`re.Pattern <re-objects>` object.
If *quiet* is ``False`` or ``0`` (the default), the filenames and other
information are printed to standard out. Set to ``1``, only errors are
@ -242,9 +243,10 @@ Public functions
cases where the source file does not exist at the time the byte-code file is
executed.
If *rx* is given, its search method is passed the full path name to the
If *rx* is given, its ``search`` method is passed the full path name to the
file being compiled, and if it returns a true value, the file is not
compiled and ``True`` is returned.
compiled and ``True`` is returned. This can be used to exclude files matching
a regular expression, given as a :ref:`re.Pattern <re-objects>` object.
If *quiet* is ``False`` or ``0`` (the default), the filenames and other
information are printed to standard out. Set to ``1``, only errors are