Skip to content

Clarify rx parameter of compileall functions #25857

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JulienPalard merged 2 commits into from
May 4, 2021
Merged

Clarify rx parameter of compileall functions #25857

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5e49320
Clarify rx parameter of compileall functions
jeanas May 3, 2021
015a367
Avoid touching re.rst, use :ref: with title and target
jeanas May 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 6 additions & 4 deletions Doc/library/compileall.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down