cpython/Doc/library
Stan Ulbrych 5424dab1fd
Some checks are pending
Tests / Windows MSI (push) Blocked by required conditions
Tests / (push) Blocked by required conditions
Tests / Android (aarch64) (push) Blocked by required conditions
Tests / Check if the ABI has changed (push) Blocked by required conditions
Tests / Change detection (push) Waiting to run
Tests / Docs (push) Blocked by required conditions
Tests / Check if Autoconf files are up to date (push) Blocked by required conditions
Tests / Check if generated files are up to date (push) Blocked by required conditions
Tests / Ubuntu SSL tests with OpenSSL (push) Blocked by required conditions
Tests / Android (x86_64) (push) Blocked by required conditions
Tests / WASI (push) Blocked by required conditions
Tests / Hypothesis tests on Ubuntu (push) Blocked by required conditions
Tests / Address sanitizer (push) Blocked by required conditions
Tests / Sanitizers (push) Blocked by required conditions
Tests / CIFuzz (push) Blocked by required conditions
Tests / All required checks pass (push) Blocked by required conditions
Lint / lint (push) Waiting to run
[3.13] gh-101100: Document zlib public constants to fix reference warnings (GH-139835) (#139912)
* gh-101100: Document `zlib` public constants to fix reference warnings (#139835)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
(cherry picked from commit c7f1da97eb)

* [3.13] gh-101100: Document `zlib` public constants to fix reference warnings (GH-139835)
(cherry picked from commit c7f1da97eb)

Co-authored-by: Stan Ulbrych <89152624+StanFromIreland@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>

---------

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
2025-10-10 18:03:48 +02:00
..
__future__.rst [3.13] gh-135755: Document __future__.* and CO_* as proper Sphinx objects (GH-135980) (GH-136371) 2025-08-02 16:19:20 +02:00
__main__.rst
_thread.rst
abc.rst
aifc.rst
allos.rst
archiving.rst
argparse.rst [3.13] GH-139067: Add example for argparse's append action (GH-131389) (#139069) 2025-09-17 17:35:37 +01:00
array.rst [3.13] gh-137183: Document that array.array typecode w is new in 3.13 (GH-137184) (GH-137209) 2025-07-29 18:45:08 +02:00
ast.rst [3.13] gh-134733: Fix documentation for the show_empty option of ast.dump() (GH-134925) (GH-134941) 2025-05-30 19:30:26 +03:00
asynchat.rst
asyncio-api-index.rst
asyncio-dev.rst
asyncio-eventloop.rst [3.13] gh-127859: Fixed documentation for call_later and call_at for early wakeup in asyncio (GH-137859) (#137907) 2025-08-19 14:27:30 +03:00
asyncio-exceptions.rst
asyncio-extending.rst
asyncio-future.rst [3.13] gh-137026: Add an explainer guide for asyncio (GH-137215) (#137582) 2025-08-09 05:35:38 +00:00
asyncio-llapi-index.rst
asyncio-platforms.rst
asyncio-policy.rst
asyncio-protocol.rst [3.13] gh-90483: fix docs of SubprocessTransport.get_pipe_transport (GH-137852) (#137854) 2025-08-16 11:17:55 +00:00
asyncio-queue.rst [3.13] Fix Queue.shutdown docs for condition to unblock a join (gh-137088) (gh-137102) 2025-07-25 08:48:28 -06:00
asyncio-runner.rst
asyncio-stream.rst [3.13] gh-138703: clarify data buffer requirement of asyncio.StreamWriter.write (GH-139564) (#139571) 2025-10-04 22:12:03 +05:30
asyncio-subprocess.rst
asyncio-sync.rst [3.13] gh-101359: clarify docs for asyncio.Event.clear (GH-137849) (#137851) 2025-08-16 16:29:26 +05:30
asyncio-task.rst [3.13] gh-137026: Add an explainer guide for asyncio (GH-137215) (#137582) 2025-08-09 05:35:38 +00:00
asyncio.rst [3.13] gh-137026: Add an explainer guide for asyncio (GH-137215) (#137582) 2025-08-09 05:35:38 +00:00
asyncore.rst
atexit.rst
audioop.rst
audit_events.rst
base64.rst
bdb.rst
binary.rst
binascii.rst
bisect.rst [3.13] GH-138465: Improve documentation for common sequence methods (GH-138474) (#138567) 2025-09-05 21:39:32 +00:00
builtins.rst
bz2.rst
calendar.rst
cgi.rst
cgitb.rst
chunk.rst
cmath.rst
cmd.rst
cmdline.rst
cmdlinelibs.rst [3.13] gh-137777: Disband the 'Program Frameworks' chapter (GH-137796) (#137831) 2025-08-15 17:50:47 +00:00
code.rst
codecs.rst [3.13] gh-123441: Correct the supported languages of the iso-8859-4 codec (GH-137034) (GH-137418) 2025-08-05 15:02:57 +00:00
codeop.rst
collections.abc.rst [3.13] gh-105812: Use the `:deco:` role in place of manual decorator markup (GH-139619) (#139628) 2025-10-05 20:28:30 +00:00
collections.rst [3.13] GH-138465: Improve documentation for common sequence methods (GH-138474) (#138567) 2025-09-05 21:39:32 +00:00
colorsys.rst
compileall.rst [3.13] gh-133503: clarify compileall -s/-p docs (GH-134756) (#134996) 2025-06-01 08:27:26 +00:00
concurrency.rst
concurrent.futures.rst [3.13] Mention the "context manager" keyword in concurrent.futures documentation (GH-130976) (#137811) 2025-08-15 19:41:04 +05:30
concurrent.rst
configparser.rst
constants.rst [3.13] gh-138307: Update the Ellipsis documentation (GH-138306) (#138439) 2025-09-05 13:47:19 -07:00
contextlib.rst
contextvars.rst
copy.rst
copyreg.rst
crypt.rst [3.13] gh-139672: Remove references to passlib (GH-139673) (#139868) 2025-10-09 17:22:01 +00:00
crypto.rst
csv.rst [3.13] gh-138005: Document that CSV skipinitialspace=True and delimiter=' ' require quotation for empty fields (GH-138006) (#138799) 2025-09-11 15:18:42 +00:00
ctypes.rst [3.13] gh-136769: Include fixed-width integers in the fundamental data types table (GH-136784) (#136786) 2025-07-19 10:25:37 +00:00
curses.ascii.rst
curses.panel.rst
curses.rst [3.13] gh-137920: Fix semantically relevant typo in curses.window.attron (GH-137940) (GH-138507) 2025-10-07 22:22:18 +02:00
custominterp.rst
dataclasses.rst [3.13] gh-105812: Use the `:deco:` role in place of manual decorator markup (GH-139619) (#139628) 2025-10-05 20:28:30 +00:00
datatypes.rst
datetime.rst
dbm.rst [3.13] Update the dbm documentation (GH-137919) (GH-137963) 2025-08-19 20:39:08 +03:00
debug.rst
decimal.rst [3.13] gh-131885: Use positional-only markers for the `decimal` module (GH-131990) (#137904) 2025-08-18 11:59:24 +00:00
development.rst
devmode.rst
dialog.rst [3.13] gh-135756: Fix nonexistent parameter in tkinter docs (GH-135770) (#135777) 2025-06-20 23:35:39 +00:00
difflib.rst [3.13] Replace ambiguous word "pound" by "hash" in difflib docs (GH-139601) (#139617) 2025-10-05 17:18:11 +00:00
dis.rst [3.13] GH-101100: Resolve reference warnings in whatsnew/3.4.rst (GH-138413) (#138444) 2025-09-03 15:47:22 +00:00
distribution.rst
distutils.rst
doctest.rst [3.13] gh-44538: Mention nested classes/functions in doctest docs (GH-137870) (GH-137917) 2025-08-18 15:05:12 +00:00
email.charset.rst
email.compat32-message.rst [3.13] gh-101100: Fix Sphinx warnings in library/email.compat32-message.rst (GH-136323) (#136390) 2025-07-07 19:51:04 +03:00
email.contentmanager.rst
email.encoders.rst
email.errors.rst
email.examples.rst
email.generator.rst
email.header.rst [3.13] Docs: Fix duplicate word typos (GH-135958) (GH-136008) 2025-06-26 20:13:46 -04:00
email.headerregistry.rst
email.iterators.rst
email.message.rst
email.mime.rst
email.parser.rst [3.13] Partially revert "gh-101100: Fix sphinx warnings in library/email.parser.rst (GH-136475)" (GH-136629) (#136647) 2025-07-14 13:19:40 +03:00
email.policy.rst
email.rst
email.utils.rst
ensurepip.rst
enum.rst [3.13] gh-139487: add missing imports for standalone doctest Enum examples (GH-139488) (#139494) 2025-10-02 14:43:33 +02:00
errno.rst
exceptions.rst [3.13] gh-123858: Improve Doc: SyntaxWarning is emitted during bytecode generation (gh-138243) 2025-08-30 00:35:17 +10:00
faulthandler.rst
fcntl.rst
filecmp.rst
fileformats.rst
fileinput.rst
filesys.rst
fnmatch.rst
fractions.rst [3.13] gh-122450: Expand documentation for `Rational and Fraction` (#136800) (#137367) 2025-08-05 14:54:31 +01:00
frameworks.rst [3.13] gh-137777: Disband the 'Program Frameworks' chapter (GH-137796) (#137831) 2025-08-15 17:50:47 +00:00
ftplib.rst
functional.rst
functions.rst [3.13] gh-137609: Update signatures of builtins in the documentation (GH-137610) (GH-138138) 2025-08-25 12:40:09 +00:00
functools.rst [3.13] gh-105812: Use the `:deco:` role in place of manual decorator markup (GH-139619) (#139628) 2025-10-05 20:28:30 +00:00
gc.rst [3.13] gh-138556: Fix old link in gc docs (#138596) 2025-09-07 10:53:56 +03:00
getopt.rst
getpass.rst
gettext.rst
glob.rst
graphlib.rst
grp.rst
gzip.rst
hashlib-blake2-tree.png
hashlib.rst [3.13] gh-139495: Fix hashlib.file_digest() versionchanged description of BlockingIOError (GH-139496) (#139528) 2025-10-02 17:17:55 -07:00
heapq.rst
hmac.rst [3.13] GH-101100: Resolve reference warnings in whatsnew/3.7.rst (GH-138410) (#138424) 2025-09-03 06:27:17 +00:00
html.entities.rst
html.parser.rst
html.rst [3.13] gh-139006: Doc: Clarify html.escape function description (GH-139016) (#139037) 2025-09-17 21:54:16 +08:00
http.client.rst
http.cookiejar.rst [3.13] gh-101100: Fix references in http.cookiejar docs (GH-136238) (GH-136317) 2025-07-05 13:35:52 +00:00
http.cookies.rst [3.13] gh-136992: Add "None" as valid SameSite value as per RFC 6265bis (GH-137040) (#137141) 2025-07-27 22:08:46 +02:00
http.rst
http.server.rst
i18n.rst
idle.rst
imaplib.rst Python 3.13.8 2025-10-07 14:01:51 +02:00
imghdr.rst
imp.rst
importlib.metadata.rst
importlib.resources.abc.rst
importlib.resources.rst [3.13] gh-136516: Mention installation artifacts as de-facto resources (GH-136419) (GH-137039) 2025-07-24 09:01:12 +02:00
importlib.rst [3.13] gh-126548: Add a thread-unsafety warning for importlib.reload() (GH-136704) (GH-136724) 2025-07-16 16:40:22 +00:00
index.rst [3.13] gh-137777: Disband the 'Program Frameworks' chapter (GH-137796) (#137831) 2025-08-15 17:50:47 +00:00
inspect.rst [3.13] gh-138966: Add description for gi_suspended attribute (GH-139008) (GH-139019) 2025-09-17 04:42:13 -04:00
internet.rst
intro.rst
io.rst
ipaddress.rst [3.13] gh-136752: Clarify documentation for `IPv{N}Address.is_reserved` (GH-136794) (#136828) 2025-07-19 14:50:37 +00:00
ipc.rst
itertools.rst [3.13] Docs: Improve example for `itertools.batched()` (GH-136775) (#136779) 2025-07-19 09:35:48 +00:00
json.rst
kde_example.png
keyword.rst
language.rst
linecache.rst
locale.rst [3.13] gh-87281: Improve documentation for locale.setlocale() and locale.getlocale() (GH-137313) (GH-137723) 2025-08-13 21:11:25 +03:00
logging.config.rst [3.13] Docs: Fix markups for emphasis (GH-135598) (GH-135686) 2025-06-18 17:44:43 +00:00
logging.handlers.rst [3.13] gh-91555: add warning to docs about possibility of deadlock/infinite recursion (GH-135954) (GH-135989) 2025-06-26 15:26:11 +01:00
logging.rst [3.13] gh-137985: Correct description of Formatter's datefmt param in logging documentation (GH-138530) (GH-138566) 2025-09-05 22:32:49 +01:00
lzma.rst
mailbox.rst
mailcap.rst
markup.rst
marshal.rst
math.rst [3.13] gh-136122: Fix video link for math.tau documentation (GH-136129) (#136132) 2025-06-30 14:49:35 +00:00
mimetypes.rst
mm.rst
mmap.rst [3.13] gh-138092: Correct the documented signature of `mmap.flush` (GH-138671) (#139203) 2025-09-21 11:05:10 +00:00
modulefinder.rst
modules.rst
msilib.rst
msvcrt.rst
multiprocessing.rst [3.13] gh-84559: improve What's New entry for multiprocessing startmethod changes (GH-128173) (#137156) 2025-07-27 18:12:16 -07:00
multiprocessing.shared_memory.rst
netdata.rst
netrc.rst [3.13] gh-135815: skip netrc security checks if os.getuid is missing (GH-135816) (#135826) 2025-06-22 20:12:20 +00:00
nis.rst
nntplib.rst
numbers.rst [3.13] gh-122450: Expand documentation for `Rational and Fraction` (#136800) (#137367) 2025-08-05 14:54:31 +01:00
numeric.rst
operator.rst
optparse.rst
os.path.rst [3.13] gh-136437: Convert more `os.path` functions to positional-only in the docs (GH-136970) (#137001) 2025-07-22 13:44:36 +00:00
os.rst [3.13] Doc/library/os.rst: Remove spurious parenthesis (GH-139205) (GH-139218) 2025-09-21 19:05:42 +00:00
ossaudiodev.rst
pathlib-inheritance.png
pathlib-inheritance.svg
pathlib.rst
pdb.rst
persistence.rst
pickle.rst [3.13] GH-138465: Improve documentation for common sequence methods (GH-138474) (#138567) 2025-09-05 21:39:32 +00:00
pickletools.rst
pipes.rst
pkgutil.rst [3.13] Docs: Emphasize parameter name in pkgutil.iter_importers (GH-135597) (GH-135711) 2025-06-19 13:04:46 +00:00
platform.rst [3.13] gh-138952: Document platform.machine() output casing inconsistency across platforms (GH-138962) (#139046) 2025-09-17 15:05:56 +00:00
plistlib.rst
poplib.rst
posix.rst
pprint.rst
profile.rst [3.13] gh-137846: Add missing 'be' to profile doc. (GH-137856) (#137858) 2025-08-16 10:56:21 -04:00
pty.rst
pwd.rst
py_compile.rst
pyclbr.rst
pydoc.rst
pyexpat.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
python.rst
queue.rst [3.13] Fix Queue.shutdown docs for condition to unblock a join (gh-137088) (gh-137102) 2025-07-25 08:48:28 -06:00
quopri.rst
random.rst [3.13] gh-101100: Fix sphinx warnings in whatsnew/3.9 (GH-136163) (#136373) 2025-07-07 10:47:59 +00:00
re.rst
readline.rst
removed.rst
reprlib.rst
resource.rst [3.13] Update the availability info in the resource docs (GH-137939) (GH-139720) 2025-10-07 22:33:20 +02:00
rlcompleter.rst
runpy.rst
sched.rst
secrets.rst
security_warnings.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
select.rst
selectors.rst
shelve.rst
shlex.rst
shutil.rst [3.13] GH-101100: Resolve reference warnings in whatsnew/2.7.rst (GH-138415) (#138442) 2025-09-03 11:42:23 +00:00
signal.rst [3.13] gh-139843: Document signals (SIGSTOP, SIGVTALRM, SIGPROF) to fix sphinx references (GH-139896) (GH-139909) 2025-10-10 15:34:52 +00:00
site.rst
smtpd.rst
smtplib.rst
sndhdr.rst
socket.rst Python 3.13.4 2025-06-03 17:34:24 +02:00
socketserver.rst [3.13] Docs: Fix duplicate word typos (GH-135958) (GH-136008) 2025-06-26 20:13:46 -04:00
spwd.rst
sqlite3.rst Python 3.13.8 2025-10-07 14:01:51 +02:00
ssl.rst [3.13] gh-138633: synchronize documented signatures of SSL objects with runtime ones (GH-138639, GH-138648) (#138647) 2025-09-18 13:07:06 +01:00
stat.rst
statistics.rst
stdtypes.rst [3.13] GH-138465: Improve documentation for common sequence methods (GH-138474) (#138567) 2025-09-05 21:39:32 +00:00
string.rst
stringprep.rst
struct.rst
subprocess.rst
sunau.rst
superseded.rst
symtable.rst
sys.monitoring.rst [3.13] gh-136697: Use the standard audit event format for sys.monitor… (#136750) 2025-07-17 11:43:20 -07:00
sys.rst [3.13] gh-91116: Add hyperlink from sys.settrace to frame objects (GH-138062) (GH-138069) 2025-08-22 14:25:55 -04:00
sys_path_init.rst
sysconfig.rst [3.13] Synced docs and docstring for sysconfig.get_platform (GH-135530) (#138975) 2025-09-17 13:22:36 +00:00
syslog.rst
tabnanny.rst
tarfile.rst [3.13] gh-86608: Improve and restructure tarfile examples (GH-121771) (#136867) 2025-07-20 14:16:26 +01:00
telnetlib.rst
tempfile.rst
termios.rst
test.rst
text.rst
textwrap.rst
threading.rst
time.rst [3.13] gh-137499: Fixed dead link to NIST website (GH-137500) (#137501) 2025-08-09 13:42:25 +01:00
timeit.rst
tk.rst [3.13] gh-137777: Disband the 'Program Frameworks' chapter (GH-137796) (#137831) 2025-08-15 17:50:47 +00:00
tk_msg.png
tkinter.colorchooser.rst
tkinter.dnd.rst
tkinter.font.rst
tkinter.messagebox.rst
tkinter.rst
tkinter.scrolledtext.rst
tkinter.ttk.rst
token-list.inc
token.rst [3.13] gh-135263: Fix typo in token.NAME documentation (GH-135275) (#135281) 2025-06-08 17:55:12 -04:00
tokenize.rst
tomllib.rst
trace.rst
traceback.rst
tracemalloc.rst
tty.rst
turtle-star.pdf
turtle-star.png
turtle-star.ps
turtle.rst
types.rst
typing.rst [3.13] gh-139842: Clarify __module__ description in typing.rst (GH-139863) (#139870) 2025-10-09 18:00:04 +00:00
unicodedata.rst [3.13] Fix the reference to unicode specification (#139138) (#139285) 2025-09-24 10:36:37 +02:00
unittest.mock-examples.rst
unittest.mock.rst [3.13] Replace "ordered arguments" with "positional arguments" in unittest.mock documentation (GH-137552) (GH-137554) 2025-08-08 14:08:01 +00:00
unittest.rst [3.13] GH-101100: Resolve reference warnings in whatsnew/3.8.rst (GH-138409) (#138438) 2025-09-03 11:32:17 +00:00
unix.rst [3.13] gh-137777: Disband the 'Program Frameworks' chapter (GH-137796) (#137831) 2025-08-15 17:50:47 +00:00
urllib.error.rst
urllib.parse.rst
urllib.request.rst [3.13] gh-137341: Remove more word duplications (GH-137342) (GH-137347) 2025-08-03 17:24:26 +00:00
urllib.robotparser.rst
urllib.rst
uu.rst
uuid.rst
venv.rst [3.13] Fix Windows path in venv docs (GH-138478) 2025-09-03 20:22:05 +00:00
warnings.rst [3.13] gh-105812: Use the `:deco:` role in place of manual decorator markup (GH-139619) (#139628) 2025-10-05 20:28:30 +00:00
wave.rst
weakref.rst
webbrowser.rst
windows.rst
winreg.rst
winsound.rst
wsgiref.rst
xdrlib.rst
xml.dom.minidom.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
xml.dom.pulldom.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
xml.dom.rst
xml.etree.elementtree.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
xml.rst [3.13] gh-127502: Fix typo in XML security notes (GH-139335) (#139345) 2025-09-26 10:08:59 +00:00
xml.sax.handler.rst [3.13] gh-101100: Resolve reference warnings in library/xml.sax.handler.rst (GH-136612) (#138422) 2025-09-03 00:43:18 +00:00
xml.sax.reader.rst
xml.sax.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
xml.sax.utils.rst
xmlrpc.client.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
xmlrpc.rst
xmlrpc.server.rst [3.13] gh-127502: Remove XML vulnerability table (GH-135294) (#136360) 2025-07-07 09:10:20 +00:00
zipapp.rst
zipfile.rst [3.13] gh-133125: Clarify ZipInfo.date_time attribute documentation (GH-136082) (#138076) 2025-08-22 17:01:37 -07:00
zipimport.rst [3.13] gh-133829: Remove some specifics from the `zipimport` example (GH-133835) (#138273) 2025-08-31 00:59:47 +00:00
zlib.rst [3.13] gh-101100: Document zlib public constants to fix reference warnings (GH-139835) (#139912) 2025-10-10 18:03:48 +02:00
zoneinfo.rst [3.13] Doc/library/zoneinfo.rst: Fix typo (GH-139190) (#139230) 2025-10-08 15:54:08 +02:00