cpython/Doc/library
Miss Islington (bot) aa06a84099
bpo-42272: fix misleading warning filter message/module docs (GH-23172)
* bpo-42272: improve message/module warning filter docs

"The Warnings Filter" section of the warnings module documentation
describes the message and module filters as "a string containing a
regular expression".  While that is true when they are arguments to the
filterwarnings function, it is not true when they appear in -W or
$PYTHONWARNINGS where they are matched literally (after stripping any
starting/ending whitespace).  Update the documentation to note when they
are matched literally.  Also clarify that module matches the
"fully-qualified module name", rather than "module name" which is
ambiguous.

skip news (since this is a doc fix)

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

* bpo-42272: remove bad submodule warning filter doc

The `error:::mymodule[.*]` example in the "Describing Warning Filters"
section of the warnings module documentation does not behave as the
comment describes.  Since the module portion of the filter string is
interpreted literally, it would match a module with a fully-qualified
name that is literally `mymodule[.*]`.

Unfortunately, there is not a way to match '"module" and any subpackages
of "mymodule"' as documented, since the module part of a filter string
is matched literally.  Instead, update the filter and comment to match
only "mymodule".

skip news (since this is a doc fix)

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

* bpo-42272: add warning filter doc changes to NEWS

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
(cherry picked from commit 8136606769)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
2022-05-29 19:03:15 -07:00
..
2to3.rst [3.10] bpo-37602: Clarify that the lib2to3 nonzero fixer changes only definitions (GH-30075) (GH-30085) 2021-12-13 10:47:38 +00:00
__future__.rst gh-92436: __future__ docs: add note on expectations for "from __future__ import annotations" (GH-92568) 2022-05-12 07:42:57 -07:00
__main__.rst Update __main__.rst (GH-30896) 2022-02-14 12:10:34 -08:00
_thread.rst bpo-43356: Allow passing a signal number to interrupt_main() (GH-24755) 2021-03-11 23:35:45 +01:00
abc.rst bpo-43698: do not use ... as argument name in docs (GH-30502) 2022-01-26 04:42:26 -08:00
aifc.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
allos.rst
archiving.rst
argparse.rst gh-92812: Align ArgumentParser.add_subparsers() docs with argument spec (GH-92814) 2022-05-18 14:30:00 -07:00
array.rst Doc: Fix the array.fromfile method doc (GH-22037) 2021-04-26 07:19:21 -07:00
ast.rst [3.10] [doc] Fix typos found using codespell (GH-28744) (GH-28758) 2021-10-06 15:56:57 +02:00
asynchat.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
asyncio-api-index.rst Fix some minor errors in the docs (GH-24834) 2021-03-13 17:00:28 -08:00
asyncio-dev.rst Improve asyncio-dev 'Concurrency and Multithreading' docs (GH-20882) 2020-08-29 16:47:38 -07:00
asyncio-eventloop.rst bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388) 2022-02-18 01:30:36 -08:00
asyncio-exceptions.rst docs: Add asyncio source code links (GH-16640) 2019-10-10 19:18:46 -04:00
asyncio-future.rst bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388) 2022-02-18 01:30:36 -08:00
asyncio-llapi-index.rst bpo-34746: Fix stop -> close (GH-9437) 2018-09-20 01:17:09 -04:00
asyncio-platforms.rst docs: Add asyncio source code links (GH-16640) 2019-10-10 19:18:46 -04:00
asyncio-policy.rst [doc] Fix erroneous backslashes in signatures and names (GH-23658) 2020-12-16 17:37:28 -08:00
asyncio-protocol.rst Subprocess Protocols Documentation (GH-20950) (GH-26133) 2021-05-14 10:22:55 -07:00
asyncio-queue.rst bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388) 2022-02-18 01:30:36 -08:00
asyncio-stream.rst [3.10] bpo-43215: Document Happy Eyeballs args of asyncio.open_connection (GH-24525) (GH-31869) 2022-03-14 15:16:29 +02:00
asyncio-subprocess.rst bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92975) 2022-05-19 17:57:46 +02:00
asyncio-sync.rst bpo-46777: Fix incorrect use of directives in asyncio documentation (GH-31388) 2022-02-18 01:30:36 -08:00
asyncio-task.rst gh-92223: Remove pre-Python 3.7 alternative in asyncio docs (GH-92224) 2022-05-04 17:30:54 -07:00
asyncio.rst [3.10] gh-92417: asyncio docs: asyncio.run() is available on all supported Python versions (GH-92419) (GH-92463) 2022-05-08 08:30:43 -07:00
asyncore.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
atexit.rst bpo-38062: [doc] clarify that atexit uses equality comparisons internally. (GH-26935) (GH-26956) 2021-06-29 18:52:27 +01:00
audioop.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
audit_events.rst bpo-42800: add audit hooks for f_code and tb_frame (GH-24182) 2021-04-30 00:15:55 +01:00
base64.rst [3.10] [doc] Fix typos found using codespell (GH-28744) (GH-28758) 2021-10-06 15:56:57 +02:00
bdb.rst [3.9] bpo-37116: Use PEP 570 syntax for positional-only parameters. (GH-12620) 2019-06-05 18:22:31 +03:00
binary.rst
binascii.rst [3.10] bpo-47040: improve document of checksum functions (GH-31955) (GH-32002) 2022-03-19 23:57:12 -07:00
binhex.rst bpo-39353: Deprecate the binhex module (GH-18025) 2020-01-22 20:44:22 +01:00
bisect.rst Fix minor documentation error in bisect docs (GH-92697) 2022-05-11 16:12:17 -07:00
builtins.rst
bz2.rst bpo-44514: Add doctest testcleanup for configparser and bz2 (GH-26909) (GH-27112) 2021-07-13 16:34:10 +02:00
calendar.rst bpo-46266: Add calendar day of week constants to __all__ (GH-30412) (GH-30424) 2022-01-23 02:00:11 +01:00
cgi.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
cgitb.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
chunk.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
cmath.rst bpo-36908: 'This module is always available' isn't helpful. (#13297) 2019-05-17 15:29:13 +05:30
cmd.rst bpo-35054: Add yet more index entries for symbols. (GH-10121) 2018-10-28 13:41:26 +02:00
code.rst bpo-38872: Document exec symbol for codeop.compile_command (GH-20047) 2020-05-14 21:59:46 -03:00
codecs.rst bpo-38056: overhaul Error Handlers section in codecs documentation (GH-15732) 2022-05-08 20:16:26 -07:00
codeop.rst bpo-38872: Document exec symbol for codeop.compile_command (GH-20047) 2020-05-14 21:59:46 -03:00
collections.abc.rst bpo-45449: add note about PEP 585 in collections.abc's documentation (GH-29047) (GH-29067) 2021-10-19 20:41:33 +02:00
collections.rst Update dict/OrderedDict differences with code equivalents. (GH-31563) 2022-02-25 07:15:58 -08:00
colorsys.rst Update link in colorsys docs to be https (GH-14062) 2019-06-15 07:09:36 -07:00
compileall.rst Clarify rx parameter of compileall functions (GH-25857) 2021-05-04 12:57:35 -07:00
concurrency.rst Put contextvars docs into the concurrency category (GH-24760) 2021-03-06 08:25:54 -08:00
concurrent.futures.rst Fix missing "," in the documentation of Executor Objects (GH-30404) 2022-01-04 11:17:16 -08:00
concurrent.rst
configparser.rst [doc] configparser: avoid inline comments. (GH-31247) 2022-03-23 01:58:49 -07:00
constants.rst bpo-41810: Reintroduce types.EllipsisType, .NoneType & .NotImplementedType (GH-22336) 2020-09-22 08:55:34 -07:00
contextlib.rst gh-92082: contextlib docs: Change aclosing from a class to a function for consistency (GH-92155) 2022-05-02 09:37:10 -07:00
contextvars.rst bpo-45792: Fix contextvar.Token's intersphinx FQN (GH-29533) (GH-29535) 2021-11-12 12:19:52 +02:00
copy.rst [3.10] bpo-45752: Fix no-support examples in 'copy' docs (GH-29548) (GH-29556) 2021-11-14 04:54:42 -08:00
copyreg.rst bpo-20823: Clarify copyreg.pickle() documentation (GH-30230) 2022-01-18 12:16:54 -08:00
crypt.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
crypto.rst
csv.rst bpo-27752: improve documentation of csv.Dialect (GH-26795) 2021-08-06 13:31:49 -07:00
ctypes.rst [3.10] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92609) 2022-05-10 02:28:22 -07:00
curses.ascii.rst bpo-35054: Add yet more index entries for symbols. (GH-10121) 2018-10-28 13:41:26 +02:00
curses.panel.rst bpo-30872: Update the curses docs to Python 3. (#2620) 2017-10-04 22:44:13 +03:00
curses.rst bpo-43084: Return bool instead of int from curses.window.enclose() (GH-24398) 2021-04-05 16:50:24 +03:00
custominterp.rst
dataclasses.rst bpo-43532: add version added to KW_ONLY (GH-31235) 2022-02-09 13:18:52 -08:00
datatypes.rst bpo-17005: Move topological sort functionality to its own module (GH-20558) 2020-06-01 00:41:14 +01:00
datetime.rst Update documentation in datetime module strftime-and-strptime-behavior fix typo in '%W' format code description (GH-30232) 2022-01-19 10:02:07 -08:00
dbm.rst [3.10] bpo-45060: Get rid of few uses of the equality operators with None (GH-28087). (GH-28092) 2021-09-03 21:13:00 -04:00
debug.rst bpo-37390: Add audit event table to documentations (GH-14406) 2019-06-27 10:47:59 -07:00
decimal.rst gh-92417: fractions, decimal: Improve docs for alternative constructor methods (GH-92421) (GH-92971) 2022-05-19 17:45:30 +02:00
development.rst bpo-39429: Add a new "Python Development Mode" doc page (GH-18132) 2020-01-24 10:22:18 +01:00
devmode.rst bpo-43774: Document configure options (GH-25283) 2021-04-08 22:32:21 +02:00
dialog.rst [doc] Fix a few margins due to bad markup (GH-23619) 2020-12-17 09:25:55 -08:00
difflib.rst bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282) 2021-01-25 15:46:06 +01:00
dis.rst [3.10] bpo-46009: Do not exhaust generator when send() method raises (GH-29986). (GH-29988) 2021-12-08 14:46:32 +00:00
distribution.rst bpo-33503: Fix the broken pypi link in the source and the documentation (GH-6814) 2018-05-15 14:58:35 -04:00
distutils.rst bpo-41282: Add deprecation warning and docs for distutils (PEP 632) (GH-24355) 2021-01-29 21:48:55 +00:00
doctest.rst gh-92417: Update docs and examples of doctest.IGNORE_EXCEPTION_DETAIL for Py>=3 (GH-92502) (GH-92963) 2022-05-19 17:19:53 +02:00
email.charset.rst [3.10] gh-77630: Change Charset to charset (GH-92439) (GH-92476) 2022-05-08 08:28:06 -07:00
email.compat32-message.rst Fix id of 'Internet Message Format' RFC in email doc (GH-24137) 2021-04-25 18:38:12 -07:00
email.contentmanager.rst [doc] Fix missing commas in signatures (#23693) 2020-12-22 11:02:52 -05:00
email.encoders.rst Fix typos in comments, docs and test names (#15018) 2019-07-30 18:16:13 -04:00
email.errors.rst bpo-30681: Support invalid date format or value in email Date header (GH-22090) 2020-10-26 17:31:06 -07:00
email.examples.rst bpo-33641: Convert RFC references into links. (GH-7103) 2018-05-31 07:39:00 +03:00
email.generator.rst Fix typos in Doc/library/email.generator.rst documentation (GH-13539) 2019-05-24 09:50:35 -04:00
email.header.rst bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282) 2021-01-25 15:46:06 +01:00
email.headerregistry.rst bpo-42770: Fix a typo in the email.headerregistry docs (GH-23982) 2020-12-28 20:12:37 -08:00
email.iterators.rst
email.message.rst bpo-38738: Fix formatting of True and False. (GH-17083) 2019-11-12 16:57:03 +02:00
email.mime.rst Fix typos in multiple .rst files (#1668) 2017-05-19 23:37:57 +03:00
email.parser.rst Correct a couple of unbalanced parenthesis. (GH-10779) 2018-12-05 21:45:30 +02:00
email.policy.rst [doc] Fix erroneous backslashes in signatures and names (GH-23658) 2020-12-16 17:37:28 -08:00
email.rst Fix id of 'Internet Message Format' RFC in email doc (GH-24137) 2021-04-25 18:38:12 -07:00
email.utils.rst bpo-30681: Support invalid date format or value in email Date header (GH-22090) 2020-10-26 17:31:06 -07:00
ensurepip.rst bpo-42856: Add --with-wheel-pkg-dir=PATH configure option (GH-24210) 2021-01-20 17:07:21 +01:00
enum.rst [3.10] [Enum] update member.member removal (GH-29608) 2021-11-17 23:38:56 -08:00
errno.rst bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380) 2022-04-04 19:30:06 -07:00
exceptions.rst bpo-41233: Add links to errnos referenced in exceptions docs (GH-21380) 2022-04-04 19:30:06 -07:00
faulthandler.rst bpo-44466: Faulthandler now detects the GC (GH-26823) (GH-26826) 2021-06-21 14:23:13 +02:00
fcntl.rst gh-87192: Update wording for fcntl 'Changed in' (GH-91658) 2022-04-30 14:44:08 -07:00
filecmp.rst bpo-42958: Improve description of shallow= in filecmp.cmp docs (GH-27166) 2021-08-04 13:03:33 -07:00
fileformats.rst [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039) 2022-03-21 17:30:21 -07:00
fileinput.rst bpo-46586: Fix more erroneous doc links to builtins (GH-31429) 2022-05-02 15:51:33 -07:00
filesys.rst bpo-35471: Remove the macpath module (GH-11129) 2018-12-14 13:37:26 +01:00
fnmatch.rst bpo-36769: Document that fnmatch.filter supports any kind of iterable (#13039) 2020-12-18 20:10:20 +01:00
fractions.rst gh-92417: fractions, decimal: Improve docs for alternative constructor methods (GH-92421) (GH-92971) 2022-05-19 17:45:30 +02:00
frameworks.rst
ftplib.rst bpo-44740: Lowercase "internet" and "web" where appropriate. (GH-27378) (GH-27380) 2021-07-27 00:34:32 +02:00
functional.rst
functions.rst bpo-39229: fix formatting in library/functions.rst (GH-17857) 2022-05-08 16:39:09 -07:00
functools.rst bpo-45701: Improve documentation for *typed* parameter (GH-29498) (GH-29509) 2021-11-18 17:12:07 +01:00
gc.rst bpo-43439: Add audit hooks for gc functions (GH-24794) 2021-03-10 00:53:57 +00:00
getopt.rst
getpass.rst bpo-32651 Recommend getpass.getuser() (#5301) 2018-01-24 12:51:29 -05:00
gettext.rst Issue3950: Fix docs for default locale used by gettext to match implementation (#18435) 2020-02-10 13:15:34 -08:00
glob.rst gh-88546: glob.glob docs: Make new paragraph for emphasis and reordered sentence (GH-91614) 2022-05-02 08:35:37 -07:00
graphlib.rst bpo-42588: Update the docs for the TopologicalSorter.static_order() method (GH-26834) 2021-06-29 04:14:52 -07:00
grp.rst bpo-47105: Cite grp.h instead of pwd.h in grp docs (GH-32091) (GH-32120) 2022-03-25 20:21:50 -04:00
gzip.rst bpo-28286: Deprecate opening GzipFile for writing implicitly. (GH-16417) 2019-11-16 18:56:57 +02:00
hashlib-blake2-tree.png Optimize images by IMGbot (GH-21348) 2022-02-04 16:31:21 +09:00
hashlib.rst bpo-42982: update pbkdf2 example & add another link (GH-30966) (#30968) 2022-03-01 15:56:25 -05:00
heapq.rst fix dangling keyfunc examples in documentation of heapq and sorted (#1432) 2018-10-15 13:06:53 -06:00
hmac.rst bpo-40791: Use CRYPTO_memcmp() for compare_digest (#20456) 2020-05-27 21:50:06 +02:00
html.entities.rst bpo-45441: Update some moved URLs in documentation (GH-28861) 2021-10-12 07:20:43 -07:00
html.parser.rst [3.10] Update html.parser.rst (GH-30678) (GH-31385) 2022-02-17 04:41:07 -08:00
html.rst bpo-31865: Fix a couple of typos in the html.unescape() docs. (GH-9662) 2018-10-01 17:34:46 -07:00
http.client.rst bpo-37363: Add audit events to the http.client module (GH-21321) 2021-04-23 12:19:08 +02:00
http.cookiejar.rst bpo-45441: Update some moved URLs in documentation (GH-28861) 2021-10-12 07:20:43 -07:00
http.cookies.rst bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282) 2021-01-25 15:46:06 +01:00
http.rst [3.10] bpo-44559: [Enum] revert enum module to 3.9 (GH-27010) 2021-07-03 21:08:42 -07:00
http.server.rst bpo-46468: document that "-m http.server" defaults to port 8000 (GH-30776) (#30787) 2022-01-22 17:31:52 +02:00
i18n.rst
idle.rst bpo-45296: Clarify close, quit, and exit in IDLE (GH-30936) (GH-30944) 2022-01-26 22:55:25 -05:00
imaplib.rst bpo-42153 Fix link to IMAP documents in imaplib.rst (GH-23297) 2020-11-15 21:02:35 -08:00
imghdr.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
imp.rst bpo-37674: Tweak imp module deprecation note in the docs (GH-20480) 2020-06-13 10:35:08 -07:00
importlib.metadata.rst [3.10] bpo-47004: Sync with importlib_metadata 4.11.3. (GH-31854). (GH-31857) 2022-03-13 17:29:50 -04:00
importlib.rst gh-92994: Clarify importlib "check" example (GH-92995) 2022-05-22 19:11:58 -07:00
index.rst gh-91547: Remove "Undocumented modules" page (GH-91682) 2022-04-22 16:33:46 -07:00
inspect.rst bpo-40838: document getdoc, getmodule, getsourcefile in inspect returns None (GH-30575) 2022-05-18 05:49:15 -07:00
internet.rst [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039) 2022-03-21 17:30:21 -07:00
intro.rst bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523) 2021-09-23 13:25:31 +03:00
io.rst gh-85864: io docs: Add missing position-only parameters (GH-91950) 2022-04-30 08:39:29 -07:00
ipaddress.rst Slight correct grammar (GH-28860) 2021-10-12 10:01:11 -07:00
ipc.rst [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039) 2022-03-21 17:30:21 -07:00
itertools.rst Add recipe for subslices (GH-31095) 2022-02-03 02:12:08 -06:00
json.rst [3.10] gh-92417: json docs: dict is ordered on all supported Python versions (GH-92422) (GH-92465) 2022-05-08 08:30:18 -07:00
keyword.rst [doc] Expand on soft keywords in the docs for keyword.py (GH-29139) (GH-29195) 2021-11-18 17:23:03 +01:00
language.rst Delete remaining references to Grammar/Grammar from docs (#21624) 2020-07-26 08:27:52 -07:00
linecache.rst bpo-21063: Improve module synopsis for distutils (GH-17363) 2019-11-25 14:17:59 -08:00
locale.rst [3.10] Document func parameter of locale.atof (GH-18183) (GH-32262) 2022-04-02 15:59:41 -07:00
logging.config.rst [3.10] bpo-46251: Add 'Security Considerations' section to logging configura… (GH-30411) (GH-30447) 2022-01-06 23:18:41 +00:00
logging.handlers.rst [3.10] bpo-42378: fixed log truncation on logging shutdown (GH-27310) (GH-30468) 2022-01-07 22:15:25 +00:00
logging.rst [3.10] gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) (GH-93150) 2022-05-23 20:45:44 +01:00
lzma.rst bpo-43785: Update bz2 document (GH-25351) 2021-04-14 08:22:49 +09:00
mailbox.rst bpo-38486: Fix dead qmail links in the mailbox docs (GH-22239) 2020-10-22 16:33:28 -07:00
mailcap.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
markup.rst
marshal.rst bpo-41180: Replace marshal code.__new__ audit event with marshal.load[s] and marshal.dumps (GH-26970) 2021-06-30 18:52:25 +01:00
math.rst bpo-45584: Clarify math.trunc documentation (GH-29183) 2022-04-02 15:30:59 -07:00
mimetypes.rst bpo-4963: Fix for initialization and non-deterministic behavior issues in mimetypes (GH-3062) 2019-06-24 16:46:59 -07:00
mm.rst [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039) 2022-03-21 17:30:21 -07:00
mmap.rst bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523) 2021-09-23 13:25:31 +03:00
modulefinder.rst
modules.rst bpo-34632: Add importlib.metadata (GH-12547) 2019-05-24 16:59:01 -07:00
msilib.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
msvcrt.rst bpo-39184: Add audit events to functions in fcntl, msvcrt, os, resource, shutil, signal, syslog (GH-18407) 2020-02-13 07:47:42 +00:00
multiprocessing.rst bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92975) 2022-05-19 17:57:46 +02:00
multiprocessing.shared_memory.rst bpo-45125: Improves pickling docs and tests for shared_memory (GH-28294) 2021-10-01 06:09:15 -07:00
netdata.rst gh-68966: Document mailcap deprecation in Python 3.11 (#91971) 2022-04-27 11:39:51 +02:00
netrc.rst bpo-43733: netrc try to use UTF-8 before using locale encoding. (GH-25781) 2021-05-02 14:01:02 +09:00
nis.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
nntplib.rst [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039) 2022-03-21 17:30:21 -07:00
numbers.rst bpo-32133: Improve numbers docs (GH-26124) (GH-26149) 2021-05-15 10:28:55 -07:00
numeric.rst
operator.rst [doc] Remove duplicated operator.itemgetter example (GH-24178) 2021-04-26 21:15:31 -07:00
optparse.rst [3.10] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92609) 2022-05-10 02:28:22 -07:00
os.path.rst [3.10] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92609) 2022-05-10 02:28:22 -07:00
os.rst gh-85133: os docs: Add that getenv uses os.environ (GH-91874) 2022-05-02 07:58:09 -07:00
ossaudiodev.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
pathlib-inheritance.png bpo-20001: update pathlib landing image (GH-11304) 2019-02-05 19:16:13 +09:00
pathlib-inheritance.svg Optimize images by IMGbot (GH-21348) 2022-02-04 16:31:21 +09:00
pathlib.rst [3.10] gh-72073: Add Windows case in pathlib.rename (GH-93002) (GH-93029) 2022-05-20 15:44:07 -07:00
pdb.rst pdb docs: workaround for double semicolon in strings (GH-17011) 2022-05-08 16:38:47 -07:00
persistence.rst
pickle.rst gh-91362: reword pickle docs to account for nested classes (GH-92429) 2022-05-21 08:10:56 -07:00
pickletools.rst
pipes.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
pkgutil.rst pkgutil docs: Link sys constants, add backticks (GH-32356) 2022-04-06 18:12:34 -07:00
platform.rst bpo-23747: Enhance platform doc, document default behavior (GH-31462) 2022-04-20 09:41:12 -07:00
plistlib.rst [3.10] [docs] Improve the markup of powers (GH-28598) (GH-28607) 2021-09-28 23:09:58 +02:00
poplib.rst bpo-41192: Fix some broken anchors for audit event entries (#21310) 2020-10-19 10:52:42 -04:00
posix.rst bpo-42029: Remove IRIX code (GH-23023) 2020-10-29 15:16:23 +01:00
pprint.rst bpo-34798: [doc] clearer presentation of pprint.PrettyPrinter constru… (GH-26967) (GH-26990) 2021-07-02 11:07:50 +01:00
profile.rst bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523) 2021-09-23 13:25:31 +03:00
pty.rst bpo-26228: [doc] Adapt PTY documentation updates from GH-4167 (GH-27754) 2021-08-13 04:21:06 -07:00
pwd.rst
py_compile.rst closes bpo-41723: Fix an error in the py_compile documentation. (GH-22110) 2020-09-05 22:39:23 -05:00
pyclbr.rst bpo-39411: pyclbr rewrite on AST (#18103) 2020-11-11 10:14:12 +03:00
pydoc.rst bpo-44740: Lowercase "internet" and "web" where appropriate. (GH-27378) (GH-27380) 2021-07-27 00:34:32 +02:00
pyexpat.rst bpo-42700: Swap descriptions in pyexpat.errors (GH-23876) 2020-12-29 14:33:15 +02:00
python.rst bpo-32216: Add documentation for dataclasses (GH-6886) 2018-05-16 04:20:43 -04:00
queue.rst gh-90879: Fix missing parameter for put_nowait() (GH-91514) 2022-04-14 02:18:31 -07:00
quopri.rst bpo-32701: Clarify the quotetabs flag in quopri documentation (GH-5401) 2018-01-29 19:36:06 -08:00
random.rst Improve multiserver queue recipe (GH-29012) (GH-29013) 2021-10-17 18:43:10 -05:00
re.rst gh-73137: Added sub-subsection headers for flags in re (GH-93000) 2022-05-22 19:06:54 -07:00
readline.rst Fix some minor errors in the docs (GH-24834) 2021-03-13 17:00:28 -08:00
reprlib.rst bpo-9842: Add references for using "..." as a placeholder to the index. (GH-10330) 2018-11-20 19:26:09 +02:00
resource.rst closes bpo-43349: Fix tuning(7) manpage hyperlink. (GH-24680) 2021-03-01 08:44:46 -06:00
rlcompleter.rst
runpy.rst gh-70979: Fix runpy.run_path parameter name in docs (GH-32265) 2022-04-14 18:23:20 -07:00
sched.rst bpo-38738: Fix formatting of True and False. (GH-17083) 2019-11-12 16:57:03 +02:00
secrets.rst gh-91611: Use example.com for documentation, not mydomain.com (GH-91613) 2022-04-30 21:03:11 -07:00
security_warnings.rst bpo-36700: [doc] Update base64 RFC references to RFC 4648 (GH-27700) 2021-08-13 04:21:53 -07:00
select.rst bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523) 2021-09-23 13:25:31 +03:00
selectors.rst Fix typo in selectors.rst (#1383) 2017-05-02 06:27:57 -07:00
shelve.rst bpo-39498 Start linking the security warnings in the stdlib modules (GH-18272) 2021-08-10 00:51:06 -07:00
shlex.rst bpo-40932: Note security caveat of shlex.quote on Windows (GH-21502) 2020-11-10 23:29:56 -08:00
shutil.rst gh-91783: Document security considerations for shutil.unpack_archive (GH-91844) 2022-05-02 10:34:59 -07:00
signal.rst Fix awkward sentence in signal docs (GH-91508) 2022-04-19 18:38:15 -07:00
site.rst bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523) 2021-09-23 13:25:31 +03:00
smtpd.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
smtplib.rst bpo-44740: Lowercase "internet" and "web" where appropriate. (GH-27378) (GH-27380) 2021-07-27 00:34:32 +02:00
sndhdr.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
socket.rst gh-92417: socket docs: remove references to Python <3.3 (GH-92544) (GH-92969) 2022-05-19 17:44:31 +02:00
socketserver.rst bpo-44740: Lowercase "internet" and "web" where appropriate. (GH-27378) (GH-27380) 2021-07-27 00:34:32 +02:00
spwd.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
sqlite3.rst gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790) 2022-05-18 05:05:24 -07:00
ssl.rst Doc: amend ssl.PROTOCOL_SSLv2 and ssl.PROTOCOL_SSLv3 wording (GH-92634) 2022-05-19 02:40:39 -07:00
stat.rst bpo-45114: Use lstat() instead of stat() in stat docs example (GH-29845) 2022-04-02 14:19:48 -07:00
statistics.rst Update potentially confusing note for mean. (GH-30174) (GH-30220) 2021-12-21 14:15:39 +00:00
stdtypes.rst [3.10] gh-92417: stdtypes docs: delete discussion of Python 2 differences (GH-92423) (GH-92473) 2022-05-08 08:26:06 -07:00
string.rst Corrections to format precision description. (GH-31291) 2022-02-13 16:21:32 -08:00
stringprep.rst bpo-38738: Fix formatting of True and False. (GH-17083) 2019-11-12 16:57:03 +02:00
struct.rst [doc] struct: update note about network byte order form to be more helpful (GH-22201) 2020-09-11 08:20:12 -07:00
subprocess.rst gh-92417: subprocess docs: remove note on compatibility with Python <3.5 (GH-92538) (GH-92973) 2022-05-19 17:49:13 +02:00
sunau.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
superseded.rst gh-68966: Document mailcap deprecation in Python 3.11 (#91971) 2022-04-27 11:39:51 +02:00
symtable.rst bpo-41224: Add versionadded for Symbol.is_annotated (GH-23861) 2020-12-29 15:32:10 +02:00
sys.rst bpo-6634: [doc] clarify that sys.exit() does not always exit the interpreter (GH-31639) 2022-03-03 06:49:22 -08:00
sysconfig.rst [3.10] bpo-45788: Link sys.prefix doc to 'Installation paths' (GH-29606) 2021-11-18 16:46:06 -05:00
syslog.rst bpo-39184: Add audit events to functions in fcntl, msvcrt, os, resource, shutil, signal, syslog (GH-18407) 2020-02-13 07:47:42 +00:00
tabnanny.rst fix function name in tabnanny documentation (GH-759) 2017-03-22 14:53:57 +08:00
tarfile.rst bpo-32695: Docs and tests for compresslevel and preset kwargs in tarfile (GH-21470) 2021-08-09 03:30:30 -07:00
telnetlib.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
tempfile.rst [3.10] gh-76773: Update docs mentioning no-longer-supported Windows versions & features (GH-92529) (GH-92609) 2022-05-10 02:28:22 -07:00
termios.rst bpo-35110: Fix unintentional spaces around hyphens and dashes. (GH-10231) 2018-10-31 02:26:06 +02:00
test.rst gh-77024: test.support: Improve documentation (GH-92513) 2022-05-27 12:25:21 -07:00
text.rst
textwrap.rst bpo-44544: add textwrap placeholder arg (GH-27671) 2022-03-19 05:47:58 -07:00
threading.rst bpo-38738: Fix formatting of True and False in the threading documentation (GH-31678) 2022-03-04 12:37:56 -08:00
time.rst bpo-31327: Update time documentation to reflect possible errors (GH-31460) 2022-03-11 11:29:48 -08:00
timeit.rst bpo-23183: Document the timeit output (GH-30359) 2022-01-14 09:47:51 -08:00
tk.rst bpo-44903: Removed othergui.rst and list of GUI frameworks (GH-27762) 2021-08-17 03:08:49 -07:00
tk_msg.png Optimize images by IMGbot (GH-21348) 2022-02-04 16:31:21 +09:00
tkinter.colorchooser.rst bpo-25237: Documentation for tkinter modules (GH-1870) 2019-09-10 10:55:34 +02:00
tkinter.dnd.rst bpo-25237: Documentation for tkinter modules (GH-1870) 2019-09-10 10:55:34 +02:00
tkinter.font.rst bpo-35728: Add root parameter to tkinter.font.nametofont() (GH-23885) 2020-12-25 23:18:06 +02:00
tkinter.messagebox.rst bpo-25237: Documentation for tkinter modules (GH-1870) 2019-09-10 10:55:34 +02:00
tkinter.rst Doc: add missing manpage and title references in tkinter docs (GH-29008) 2022-05-20 02:21:29 -07:00
tkinter.scrolledtext.rst bpo-25237: Documentation for tkinter modules (GH-1870) 2019-09-10 10:55:34 +02:00
tkinter.tix.rst bpo-23156: Remove obsolete tix install directions (GH-11595) 2019-01-17 19:00:51 -05:00
tkinter.ttk.rst bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523) 2021-09-23 13:25:31 +03:00
token-list.inc bpo-43822: Improve syntax errors for missing commas (GH-25377) 2021-04-15 21:38:45 +01:00
token.rst bpo-40204: Add :noindex: in the documentation (GH-21859) 2020-08-13 21:41:54 +02:00
tokenize.rst fix comma location in various places (GH-19233) 2020-03-30 14:28:25 -07:00
trace.rst [doc] Fix a few margins due to bad markup (GH-23619) 2020-12-17 09:25:55 -08:00
traceback.rst bpo-42877: add the 'compact' param to TracebackException's __init__ (#24179) 2021-01-14 18:45:02 -08:00
tracemalloc.rst bpo-42038: fix description of returned list of lines (GH-27529) (GH-28428) 2021-09-18 00:55:57 +02:00
tty.rst
tulip_coro.dia
tulip_coro.png bpo-30660: Doc: Optimize PNG files by optipng (GH-8032) 2018-07-01 16:02:52 +09:00
turtle-star.pdf
turtle-star.png bpo-30660: Doc: Optimize PNG files by optipng (GH-8032) 2018-07-01 16:02:52 +09:00
turtle-star.ps
turtle.rst Fix hyperlink conflict in turtle docs (GH-27592) 2021-08-04 11:14:12 -07:00
types.rst bpo-45391: mark UnionType as a class in documentation (GH-28757) 2021-12-09 05:17:36 -08:00
typing.rst gh-92417: typing docs: from __future__ import annotations can be used in all supported Python versions (GH-92418) 2022-05-08 08:04:18 -07:00
unicodedata.rst Update some www.unicode.org URLs to use HTTPS. (GH-18912) 2020-03-10 21:10:59 -07:00
unittest.mock-examples.rst Use the zero argument form of super() in examples for Python3 docs. (GH-22314) 2021-04-26 15:13:54 -07:00
unittest.mock.rst bpo-47235: Note where a typo is intentional in code. (GH-32348) 2022-04-06 08:30:01 -07:00
unittest.rst [3.10] Fix typo in unittest.rst: addCleanupModule -> addModuleCleanup (GH-92631) (GH-92660) 2022-05-11 03:50:00 -07:00
unix.rst [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039) 2022-03-21 17:30:21 -07:00
urllib.error.rst bpo-33641: Convert RFC references into links. (GH-7103) 2018-05-31 07:39:00 +03:00
urllib.parse.rst docs: Improve example for urlparse() (GH-29816) (GH-29888) 2021-12-02 12:25:13 +02:00
urllib.request.rst bpo-46586: Fix more erroneous doc links to builtins (GH-31429) 2022-05-02 15:51:33 -07:00
urllib.robotparser.rst bpo-44740: Lowercase "internet" and "web" where appropriate. (GH-27378) (GH-27380) 2021-07-27 00:34:32 +02:00
urllib.rst
uu.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
uuid.rst bpo-38619: Update the documentation for UUID.hex (GH-29830) 2022-02-14 11:20:48 -08:00
venv.rst [doc] Add a missing apostrophe in a code example in venv.rst (GH-28391) (GH-28425) 2021-09-18 00:18:03 +02:00
warnings.rst bpo-42272: fix misleading warning filter message/module docs (GH-23172) 2022-05-29 19:03:15 -07:00
wave.rst bpo-37320: Remove openfp() of aifc, sunau and wave (GH-14169) 2019-06-18 00:00:24 +02:00
weakref.rst [doc] Mention __slots__ behavior in weakref.rst (GH-21061) (GH-28772) 2021-10-06 20:52:22 +02:00
webbrowser.rst bpo-41203: Replace Mac OS X and OS X with macOS (GH-28515) (GH-28523) 2021-09-23 13:25:31 +03:00
windows.rst [3.10] bpo-47061: document module deprecations due to PEP 594 (GH-31984) (GH-32039) 2022-03-21 17:30:21 -07:00
winreg.rst [doc] Fix erroneous backslashes in signatures and names (GH-23658) 2020-12-16 17:37:28 -08:00
winsound.rst
wsgiref.rst bpo-41778: Change a punctuation on documentation. (GH-22229) 2020-09-13 14:05:44 -07:00
xdrlib.rst gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612) 2022-05-13 13:11:05 -07:00
xml.dom.minidom.rst bpo-42253: Update xml.dom.minidom.rst (GH-23126) (GH-28874) 2021-10-12 10:17:53 +03:00
xml.dom.pulldom.rst Fix Python version since which external enities are not resolved by default. (GH-11237) 2018-12-19 15:29:04 +02:00
xml.dom.rst Update the OMG link (GH-30383) 2022-02-15 09:17:00 -08:00
xml.etree.elementtree.rst bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92975) 2022-05-19 17:57:46 +02:00
xml.rst bpo-44394: Update libexpat copy to 2.4.1 (GH-26945) 2021-08-29 07:32:50 -07:00
xml.sax.handler.rst bpo-6686: Replace String with Bytes in xml.sax.handler documentation (GH-30612) 2022-05-02 15:44:07 -07:00
xml.sax.reader.rst bpo-31658: Make xml.sax.parse accepting Path objects (GH-8564) 2019-04-14 11:16:54 +02:00
xml.sax.rst Fix Python version since which external enities are not resolved by default. (GH-11237) 2018-12-19 15:29:04 +02:00
xml.sax.utils.rst
xmlrpc.client.rst [3.10] bpo-43504: Remove effbot urls (GH-26308) (#92161) 2022-05-02 12:21:51 -06:00
xmlrpc.rst
xmlrpc.server.rst bpo-7769: enable xmlrpc.server.SimpleXMLRPCDispatcher.register_function used as decorator (GH-231) 2017-02-28 17:12:52 +08:00
zipapp.rst bpo-40131: Fix source and target order in zipapp example (GH-19290) 2020-04-03 22:06:29 +05:30
zipfile.rst bpo-46586: Fix more erroneous doc links to builtins (GH-31429) 2022-05-02 15:51:33 -07:00
zipimport.rst bpo-28816: [doc] clarify that zipimport invokes importers only for python files (GH-30060) (GH-30133) 2021-12-16 12:23:41 +00:00
zlib.rst [3.10] bpo-47040: improve document of checksum functions (GH-31955) (GH-32002) 2022-03-19 23:57:12 -07:00
zoneinfo.rst bpo-43774: Add more links to configure options (GH-25363) 2021-04-12 23:27:35 +02:00