cpython/Doc/library
Petr Viktorin ff0ef0a54b
gh-123832: Adjust socket.getaddrinfo docs for better POSIX compliance (GH-126182)
* gh-123832: Adjust `socket.getaddrinfo` docs for better POSIX compliance

This changes nothing changes for CPython supported platforms,
but hints how to deal with platforms that stick to the letter of
the spec.
It also marks `socket.getaddrinfo` as a wrapper around `getaddrinfo(3)`;
specifically, workarounds to make the function work consistently across
platforms are out of scope in its code.

Include wording similar to the POSIX's “by providing options and by
limiting the returned information”, which IMO suggests that the
hints limit the resulting list compared to the defaults, *but* can
be interpreted differently. Details are added in a note.

Specifically say that this wraps the underlying C function. So, the
details are in OS docs. The “full range of results” bit goes away.

Use `AF_UNSPEC` rather than zero for the *family* default, although
I don't think a system where it's nonzero would be very usable.

Suggest setting proto and/or type (with examples, as the appropriate
values aren't obvious). Say why you probably want to do that that
on all systems; mention the behavior on the “letter of the spec”
systems.

Suggest that the results should be tried in order, which is,
AFAIK best practice -- see RFC 6724 section 2, and its predecessor
from 2003 (which are specific to IP, but indicate how people use this):

> Well-behaved applications SHOULD iterate through the list of
> addresses returned from `getaddrinfo()` until they find a working address.


Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-11-14 09:31:14 +01:00
..
__future__.rst gh-125168: Fix typo in __future__.rst (#125183) 2024-10-09 16:17:18 +03:00
__main__.rst gh-90437: Fix __main__.py documentation wording (GH-116309) 2024-07-04 15:49:14 -07:00
_thread.rst gh-125541: Make Ctrl-C interrupt threading.Lock.acquire() on Windows (#125546) 2024-10-17 20:10:55 +02:00
abc.rst gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) 2024-09-25 19:29:58 +00:00
aifc.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
allos.rst gh-118689: Doc: fix ePub build (#118690) 2024-05-10 19:24:02 +09:00
annotationlib.rst gh-119180: Rename SOURCE format to STRING (#124620) 2024-09-26 13:49:48 -07:00
archiving.rst
argparse.rst gh-126071: Improve formatting of the argparse documentation (GH-126073) 2024-10-30 08:50:12 +00:00
array.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
ast.rst Python 3.14.0a1 2024-10-15 22:34:54 +03:00
asynchat.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
asyncio-api-index.rst
asyncio-dev.rst gh-124694: Add concurrent.futures.InterpreterPoolExecutor (gh-124548) 2024-10-16 16:50:46 -06:00
asyncio-eventloop.rst Update documentation links to Microsoft's documentation pages (GH-126379) 2024-11-11 17:10:49 +00:00
asyncio-exceptions.rst
asyncio-extending.rst
asyncio-future.rst Docs: spelling and grammar fixes (#122084) 2024-07-22 09:14:25 +08:00
asyncio-llapi-index.rst gh-124694: Add concurrent.futures.InterpreterPoolExecutor (gh-124548) 2024-10-16 16:50:46 -06:00
asyncio-platforms.rst GH-120804: add docs for removal for asyncio child watchers (#120895) 2024-06-23 13:14:12 +00:00
asyncio-policy.rst gh-126353: remove implicit creation of loop from asyncio.get_event_loop (#126354) 2024-11-04 14:21:20 +05:30
asyncio-protocol.rst gh-113812: Allow DatagramTransport.sendto to send empty data (#115199) 2024-02-16 18:38:07 -08:00
asyncio-queue.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
asyncio-runner.rst gh-120284: Enhance asyncio.run to accept awaitable objects (#120566) 2024-09-26 11:45:08 +05:30
asyncio-stream.rst gh-117722: Fix Stream.readuntil with non-bytes buffer objects (#117723) 2024-04-11 07:41:55 -07:00
asyncio-subprocess.rst GH-120804: add docs for removal for asyncio child watchers (#120895) 2024-06-23 13:14:12 +00:00
asyncio-sync.rst gh-112202: Ensure that condition.notify() succeeds even when racing with Task.cancel() (#112201) 2024-02-03 08:19:37 -08:00
asyncio-task.rst gh-125289: Update sample code in asyncio-task.rst (GH-125292) 2024-10-12 13:38:13 -07:00
asyncio.rst gh-121957: Emit audit events for python -i and python -m asyncio (GH-121958) 2024-07-22 13:04:08 +02:00
asyncore.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
atexit.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
audioop.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
audit_events.rst gh-115777: Fix double versionadded directives (GH-116269) 2024-03-05 17:41:53 +02:00
base64.rst Clarify base64.a85encode docs: *wrapcols* doesn't count the newline (GH-119409) 2024-05-24 00:11:45 +02:00
bdb.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
binary.rst
binascii.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
bisect.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
builtins.rst gh-99030: Added documentation links for types and exceptions (GH-123857) 2024-10-20 17:36:27 -07:00
bz2.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
calendar.rst gh-123445: calendar: Improve descriptions for day and month attributes (#123483) 2024-09-25 10:24:47 +01:00
cgi.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
cgitb.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
chunk.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
cmath.rst gh-126165: Improve docs of function math.isclose (#126215) 2024-11-03 23:08:15 -05:00
cmd.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
cmdline.rst gh-123834: Add symtable to the list of modules with a CLI (#123835) 2024-09-09 13:45:43 +02:00
code.rst gh-74929: PEP 667 general docs update (gh-119201) 2024-05-21 03:32:15 +00:00
codecs.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
codeop.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
collections.abc.rst gh-114990: Add missing mixin methods in collections.abc's document (GH-114991) 2024-10-30 13:17:20 -07:00
collections.rst gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) 2024-09-25 19:29:58 +00:00
colorsys.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
compileall.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
concurrency.rst
concurrent.futures.rst Doc: Fix typos (#125728) 2024-10-21 10:44:18 +02:00
concurrent.rst
configparser.rst gh-125436: Doc: Add missing `allow_unnamed_section parameter to ConfigParser` documentation (#125437) 2024-11-05 02:58:15 +00:00
constants.rst gh-103066: Add links and help in site.py constants (#103777) 2024-09-06 10:29:28 +03:00
contextlib.rst Docs: spelling and grammar fixes (#122084) 2024-07-22 09:14:25 +08:00
contextvars.rst gh-124872: Refine contextvars documentation (#124773) 2024-10-09 16:44:03 -07:00
copy.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
copyreg.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
crypt.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
crypto.rst
csv.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
ctypes.rst gh-120313: amend documentation regarding ctypes._CFuncPtr (GH-120989) 2024-10-25 15:32:23 +02:00
curses.ascii.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
curses.panel.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
curses.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
custominterp.rst
dataclasses.rst gh-118974: Add decorator argument to make_dataclass (gh-122723) 2024-10-01 09:51:51 -04:00
datatypes.rst
datetime.rst gh-85453: Improve variable mark up for datetime.rst (#120702) 2024-10-15 00:02:58 +02:00
dbm.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
debug.rst
decimal.rst gh-121798: Add class method Decimal.from_number() (GH-121801) 2024-10-14 08:24:01 +00:00
development.rst
devmode.rst
dialog.rst
difflib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
dis.rst gh-122838: Document missing opcodes (#123073) 2024-11-06 12:16:13 +00:00
distribution.rst
distutils.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
doctest.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.charset.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.compat32-message.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
email.contentmanager.rst gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) 2024-09-25 19:29:58 +00:00
email.encoders.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.errors.rst gh-121650: Encode newlines in headers, and verify headers are sound (GH-122233) 2024-07-31 00:19:48 +02:00
email.examples.rst
email.generator.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.header.rst gh-120276: Fix incorrect email.header.Header maxlinelen default (GH-120277) 2024-06-08 20:18:58 +03:00
email.headerregistry.rst gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) 2024-09-25 19:29:58 +00:00
email.iterators.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.message.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
email.mime.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.parser.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.policy.rst gh-121650: Encode newlines in headers, and verify headers are sound (GH-122233) 2024-07-31 00:19:48 +02:00
email.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
email.utils.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
ensurepip.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
enum.rst docs: add a more precise example in enum doc (GH-121015) 2024-11-01 12:28:50 -07:00
errno.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
exceptions.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
faulthandler.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
fcntl.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
filecmp.rst gh-57141: Make shallow argument to filecmp.dircmp keyword-only (#121767) 2024-07-14 15:53:32 -07:00
fileformats.rst
fileinput.rst gh-120345: Fix incorrect use of the :class: role with the "()" suffix (GH-120347) 2024-06-12 17:23:03 +03:00
filesys.rst
fnmatch.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
fractions.rst gh-121797: Add class method Fraction.from_number() (GH-121800) 2024-10-14 07:54:59 +00:00
frameworks.rst
ftplib.rst gh-120823: Fix doc for ftplib.FTP.retrbinary() (GH-121697) 2024-07-13 16:16:26 +02:00
functional.rst
functions.rst gh-119793: Add optional length-checking to map() (GH-120471) 2024-11-04 15:00:19 +01:00
functools.rst gh-125916: Allow functools.reduce() 'initial' to be a keyword argument (#125917) 2024-11-12 13:11:58 +00:00
gc.rst GH-117759: Document incremental GC (GH-123266) 2024-08-27 15:23:39 +01:00
getopt.rst gh-126390: Support for preserving order of options and nonoption arguments in gnu_getopt() (GH-126393) 2024-11-13 22:50:46 +02:00
getpass.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
gettext.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
glob.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
graphlib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
grp.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
gzip.rst gh-125260: Change the default `gzip.compress()` mtime to 0 (#125261) 2024-10-12 18:18:48 +01:00
hashlib-blake2-tree.png
hashlib.rst GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) 2024-09-17 02:53:38 +00:00
heapq.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
hmac.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
html.entities.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
html.parser.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
html.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
http.client.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
http.cookiejar.rst GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) 2024-09-17 02:53:38 +00:00
http.cookies.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
http.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
http.server.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
i18n.rst
idle.rst Docs: fix typos in documentation (#118752) 2024-05-08 12:20:40 -06:00
imaplib.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
imghdr.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
imp.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
importlib.metadata.rst Fix incorrect indentation in importlib.metadata.rst (GH-126189) 2024-10-30 10:46:09 -07:00
importlib.resources.abc.rst Docs: spelling and grammar fixes (#122084) 2024-07-22 09:14:25 +08:00
importlib.resources.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
importlib.rst gh-101100: Consolidate documentation on ModuleType attributes (#124709) 2024-10-09 10:53:57 +00:00
index.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
inspect.rst gh-126072: do not add None to co_consts if there is no docstring (GH-126101) 2024-10-30 09:01:09 +00:00
internet.rst
intro.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
io.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
ipaddress.rst gh-118710: Make IPv*Address.version & max_prefixlen available on the class (GH-120698) 2024-09-04 15:51:12 +02:00
ipc.rst
itertools.rst Misc improvements to the itertools docs (gh-125147) 2024-10-08 14:02:58 -05:00
json.rst GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) 2024-09-17 02:53:38 +00:00
kde_example.png Improve kde graph with better caption and number formatting (gh-113967) 2024-01-11 18:25:18 -06:00
keyword.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
language.rst
linecache.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
locale.rst gh-124969: Make locale.nl_langinfo(locale.ALT_DIGITS) returning a string again (GH-125774) 2024-10-21 18:54:12 +00:00
logging.config.rst gh-124653: Relax (again) detection of queue API for logging handlers (GH-124897) 2024-10-07 19:42:19 +01:00
logging.handlers.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
logging.rst gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) 2024-09-25 19:29:58 +00:00
lzma.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
mailbox.rst Docs: spelling and grammar fixes (#122084) 2024-07-22 09:14:25 +08:00
mailcap.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
markup.rst
marshal.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
math.rst gh-119793: Prefer map(..., strict=True) over starmap/zip in examples (#126407) 2024-11-05 08:53:32 +01:00
mimetypes.rst Document `mimetypes.MimeTypes.add_type()` (#122301) 2024-07-26 22:03:08 +00:00
mm.rst
mmap.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
modulefinder.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
modules.rst
msilib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
msvcrt.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
multiprocessing.rst gh-84559: Change the multiprocessing start method default to forkserver (GH-101556) 2024-09-26 16:57:19 -07:00
multiprocessing.shared_memory.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
netdata.rst
netrc.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
nis.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
nntplib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
numbers.rst docs: fix a few typos identified by codespell (#119516) 2024-05-25 18:13:31 -07:00
numeric.rst
operator.rst gh-115808: Add `is_none and is_not_none to operator` (#115814) 2024-08-10 20:16:34 +01:00
optparse.rst Docs: spelling and grammar fixes (#122084) 2024-07-22 09:14:25 +08:00
os.path.rst Doc: Improve wording of `os.path.commonpath()` (#122627) 2024-08-03 11:18:59 +00:00
os.rst gh-125298: Remove misleading text in os.kill documentation (GH-125749) 2024-11-08 15:29:16 +00:00
ossaudiodev.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
pathlib-inheritance.png
pathlib-inheritance.svg
pathlib.rst GH-124985: Document that pathlib.Path.copy() uses copy-on-write. (#125861) 2024-11-05 18:43:43 +00:00
pdb.rst gh-124400: Use the normal command path for breakpoint commands (#124401) 2024-09-29 19:46:16 -04:00
persistence.rst
pickle.rst gh-118830: Bump pickle.DEFAULT_PROTOCOL to 5 (GH-119340) 2024-07-19 16:47:10 +02:00
pickletools.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
pipes.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
pkgutil.rst gh-97850: remove `find_loader and get_loader from pkgutil` (#119656) 2024-11-01 18:35:22 +02:00
platform.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
plistlib.rst Docs: spelling and grammar fixes (#122084) 2024-07-22 09:14:25 +08:00
poplib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
posix.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
pprint.rst gh-126731: Update outdated project information in pprint.pp doc (#126732) 2024-11-13 20:58:06 -08:00
profile.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
pty.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
pwd.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
py_compile.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
pyclbr.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
pydoc.rst Doc: Note that pydoc uses and prefers `MANPAGER` (#125362) 2024-10-29 23:12:02 +00:00
pyexpat.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
python.rst gh-119180: Documentation for PEP 649 and 749 (#122235) 2024-09-11 07:49:59 -07:00
queue.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
quopri.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
random.rst gh-123968: fix -f/--float command line option description (#124517) 2024-09-25 09:47:45 -07:00
re.rst gh-124130: Notes on empty string corner case of category \B (#124133) 2024-09-23 08:58:14 +02:00
readline.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
removed.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
reprlib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
resource.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
rlcompleter.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
runpy.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
sched.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
secrets.rst gh-123789: secrets.randbits returns only non-negative int (#123801) 2024-09-07 21:17:59 -07:00
security_warnings.rst
select.rst gh-121905: Consistently use "floating-point" instead of "floating point" (GH-121907) 2024-07-19 08:06:02 +00:00
selectors.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
shelve.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
shlex.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
shutil.rst Doc: Improve documentation for the `path argument in shutil.which()` (#124494) 2024-09-25 08:54:13 +01:00
signal.rst gh-123014: Disable pidfd API on older Android versions (#124458) 2024-09-25 16:23:30 +02:00
site.rst gh-103066: Add links and help in site.py constants (#103777) 2024-09-06 10:29:28 +03:00
smtpd.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
smtplib.rst gh-120662: Improve smtplib example (#120668) 2024-06-18 13:56:58 +02:00
sndhdr.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
socket.rst gh-123832: Adjust socket.getaddrinfo docs for better POSIX compliance (GH-126182) 2024-11-14 09:31:14 +01:00
socketserver.rst gh-111872: Document the max_children attribute for socketserver.ForkingMixIn (#118134) 2024-07-03 13:16:57 +05:30
spwd.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
sqlite3.rst gh-126259: Fix "unclosed database" warning in sqlite3 doctest (#126260) 2024-11-01 08:17:05 +01:00
ssl.rst GH-103484: Fix broken links reported by linkcheck (#124169) 2024-09-17 17:05:15 +02:00
stat.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
statistics.rst gh-121977: Add tips for handling unhashable data (#122075) 2024-07-21 05:53:26 +00:00
stdtypes.rst gh-116938: Fix dict.update docstring and remove erraneous full stop from dict documentation (#125421) 2024-10-29 23:00:04 +00:00
string.rst gh-99880: document rounding mode for new-style formatting (GH-121481) 2024-11-02 10:11:12 -07:00
stringprep.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
struct.rst gh-121249: Support _Complex types in the struct module (#121613) 2024-10-07 13:53:02 +02:00
subprocess.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
sunau.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
superseded.rst
symtable.rst Python 3.14.0a1 2024-10-15 22:34:54 +03:00
sys.monitoring.rst gh-116750: Add clear_tool_id function to unregister events and callbacks (#124568) 2024-10-01 13:32:55 -04:00
sys.rst gh-124855: Don't allow the JIT and perf support to be active at the same time (#124856) 2024-10-30 00:12:45 +00:00
sys_path_init.rst
sysconfig.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
syslog.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tabnanny.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tarfile.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
telnetlib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
tempfile.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
termios.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
test.rst gh-101100: Add a table of class attributes to the "Custom classes" section of the data model docs (#124480) 2024-09-25 19:29:58 +00:00
text.rst
textwrap.rst docs: fix a few typos identified by codespell (#119516) 2024-05-25 18:13:31 -07:00
threading.rst gh-125541: Make Ctrl-C interrupt threading.Lock.acquire() on Windows (#125546) 2024-10-17 20:10:55 +02:00
time.rst Update documentation links to Microsoft's documentation pages (GH-126379) 2024-11-11 17:10:49 +00:00
timeit.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tk.rst
tk_msg.png
tkinter.colorchooser.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.dnd.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
tkinter.font.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.messagebox.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.rst GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) 2024-09-17 02:53:38 +00:00
tkinter.scrolledtext.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tkinter.ttk.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
token-list.inc
token.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
tokenize.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tomllib.rst gh-126175: Add attributes to TOMLDecodeError. Deprecate free-form __init__ args (GH-126428) 2024-11-13 13:52:16 +01:00
trace.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
traceback.rst gh-71784: [doc] add usage examples for traceback.TracebackException (#125189) 2024-10-10 11:21:12 +01:00
tracemalloc.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
tty.rst Format None, True, False and NotImplemented as literals (GH-118758) 2024-05-08 22:35:16 +03:00
tulip_coro.dia
tulip_coro.png
turtle-star.pdf
turtle-star.png
turtle-star.ps
turtle.rst gh-125665: Update turtledemo docstrings with correct file names (#125691) 2024-10-23 16:29:32 -04:00
types.rst gh-101100: Consolidate documentation on ModuleType attributes (#124709) 2024-10-09 10:53:57 +00:00
typing.rst gh-126543: Docs: change "bound type var" to "bounded" when used in the context of the 'bound' kw argument to TypeVar (#126584) 2024-11-10 16:40:25 -08:00
unicodedata.rst closes gh-124016: update Unicode to 16.0.0 (#124017) 2024-09-13 07:47:04 -07:00
unittest.mock-examples.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
unittest.mock.rst gh-101100: Fix Sphinx warnings in library/unittest.mock.rst (#124106) 2024-10-09 17:02:18 +03:00
unittest.rst gh-80958: unittest: discovery support for namespace packages as start directory (#123820) 2024-10-23 13:41:33 +09:00
unix.rst
urllib.error.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
urllib.parse.rst gh-116897: Deprecate generic false values in urllib.parse.parse_qsl() (GH-116903) 2024-11-12 21:10:29 +02:00
urllib.request.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
urllib.robotparser.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
urllib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
uu.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
uuid.rst gh-89083: add support for UUID version 8 (RFC 9562) (#123224) 2024-11-12 19:08:49 +01:00
venv.rst docs: in venv table use executable name (GH-124315) 2024-10-09 09:04:35 +01:00
warnings.rst gh-125761: Clarify repeated warning suppression criteria in warnings module (gh-126326) 2024-11-02 21:37:26 +10:00
wave.rst gh-123517: Remove unnecessary `:meth:` parentheses (#123518) 2024-09-01 05:59:42 +01:00
weakref.rst Docs: Standardise versionchanged text in weakref.rst (#122898) 2024-08-11 21:40:11 +01:00
webbrowser.rst gh-116622: Complete Android documentation (#124259) 2024-09-23 23:09:53 +00:00
windows.rst
winreg.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
winsound.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
wsgiref.rst Use pep role instead of url (#121611) 2024-09-17 16:02:14 +03:00
xdrlib.rst Docs: re-create pages for removed modules to document their removal. (#126622) 2024-11-11 17:49:48 -05:00
xml.dom.minidom.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.dom.pulldom.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.dom.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.etree.elementtree.rst Fix typo in XMLParser doc (#124129) 2024-09-20 12:42:44 +02:00
xml.rst Docs: add link roles with Sphinx extlinks (#117850) 2024-04-15 21:22:00 +03:00
xml.sax.handler.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.sax.reader.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.sax.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xml.sax.utils.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
xmlrpc.client.rst GH-103484: Fix permanently redirects reported by linkcheck (GH-124144) 2024-09-17 02:53:38 +00:00
xmlrpc.rst
xmlrpc.server.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
zipapp.rst gh-123492: Remove unnecessary :func: parentheses (#123493) 2024-08-30 14:34:09 +03:00
zipfile.rst gh-119588: Update docs to reflect decision to include the change with Python 3.13 and not 3.12. (#120043) 2024-06-04 15:20:01 +00:00
zipimport.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
zlib.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00
zoneinfo.rst docs: module page titles should not start with a link to themselves (#117099) 2024-05-08 20:34:40 +01:00