summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.11] Docs: bump Pygments to fix contrast ratios to meet WCAG AA guidelines ↵Miss Islington (bot)2023-10-021-2/+1
| | | | | | (GH-110208) (#110211) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-110138: Improve grammar in idiomatic usage of ``__main__.py`` ↵Miss Islington (bot)2023-10-011-3/+3
| | | | | | | | (GH-110142) (#110189) gh-110138: Improve grammar in idiomatic usage of ``__main__.py`` (GH-110142) (cherry picked from commit adf0f15a06c6e8ddd1a6d59b28efcbb26289f080) Co-authored-by: Quentin Agren <quentin.agren@gmail.com>
* [3.11] gh-101100: Fix sphinx warnings in `library/site.rst` (GH-110144) ↵Miss Islington (bot)2023-10-013-13/+25
| | | | | | | (#110185) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.11] GH-101100: Fix reference warnings for ``gettext`` (GH-110115) (#110141)Miss Islington (bot)2023-09-301-29/+26
| | | | Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] GH-101100: Fix reference warnings for ``namedtuple`` (GH-110113) ↵Miss Islington (bot)2023-09-301-3/+3
| | | | | | | | (#110136) GH-101100: Fix reference warnings for ``namedtuple`` (GH-110113) (cherry picked from commit cbdacc738a52a876aae5b74b4665d30a5f204766) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-102304: Add links to the Stable ABI and Limited C API docs ↵Adam Turner2023-09-298-27/+40
| | | | | | (#105345) (#105371) (#109901) * Add "limited-c-api" and "stable-api" targets * Rename the "stable-abi-list" target to "limited-api-list"
* [3.11] gh-101100: Fix references to ``URLError`` and ``HTTPError`` in ↵Miss Islington (bot)2023-09-291-8/+8
| | | | | | | ``howto/urllib2.rst`` (GH-107966) (#110087) Co-authored-by: Yuki K <drsuaimqjgar@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-101100: Fix Sphinx warnings in `tutorial/controlflow.rst` ↵Miss Islington (bot)2023-09-292-3/+2
| | | | | | | (GH-109424) (#110085) Co-authored-by: Maciej Olko <maciej.olko@affirm.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-101100: Fix sphinx warnings in `library/difflib.rst` (GH-110074) ↵Hugo van Kemenade2023-09-292-10/+9
| | | | | | (#110082) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-109634: Use :samp: role (GH-109635) (GH-109778)Serhiy Storchaka2023-09-2922-86/+90
| | | | | (cherry picked from commit 92af0cc580051fd1129c7a86af2cbadeb2aa36dc) Co-authored-by: Jacob Coffee <jacob@z7x.org>
* [3.11] Enhance TypedDict docs around required/optional keys (GH-109547) ↵Miss Islington (bot)2023-09-271-0/+15
| | | | | | | | | | (#109983) As discussed in comments to GH-109544, the semantics of this attribute are somewhat confusing. Add a note explaining its limitations and steering users towards __required_keys__ and __optional_keys__ instead. (cherry picked from commit f49958c886a2f2608f1008186d588efc2a98b445) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.11] gh-101100: Fix sphinx warnings in `library/devmode.rst` (GH-109963) ↵Miss Islington (bot)2023-09-272-3/+3
| | | | | | | (#109967) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] gh-107298: Document PyMODINIT_FUNC macro (#109236) (#109948)Victor Stinner2023-09-273-2/+26
| | | | | | | | | | | gh-107298: Document PyMODINIT_FUNC macro (#109236) Document PyMODINIT_FUNC macro. Remove links to PyAPI_FUNC() and PyAPI_DATA() macros since they are not documented. These macros should only be used to define the Python C API. They should not be used outside Python code base. (cherry picked from commit d7a27e527d7e669d2e45cff80ad725978226477c)
* [3.11] gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) ↵Miss Islington (bot)2023-09-272-9/+8
| | | | | | | | (#109938) gh-101100: Fix Sphinx warnings in Doc/using/configure.rst (GH-109931) (cherry picked from commit 3538930d87e6bdd2bfffa3f674a62cc91d359d31) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.11] gh-101100: Fix Sphinx warnings in `Doc/library/weakref.rst` ↵Miss Islington (bot)2023-09-262-11/+9
| | | | | | (GH-109881) (#109883) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-101100: Fix sphinx warnings in ↵Miss Islington (bot)2023-09-242-2/+6
| | | | | | | | | | | `Doc/library/xml.etree.elementtree.rst` (GH-109799) (#109801) gh-101100: Fix sphinx warnings in `Doc/library/xml.etree.elementtree.rst` (GH-109799) (cherry picked from commit 649768fb6781ba810df44017fee1975a11d65e2f) gh-101100: Fix shpinx warnings in `Doc/library/xml.etree.elementtree.rst` Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] GH-95913: Add the release date for Python 3.11 (GH-109750) (#109772)Miss Islington (bot)2023-09-232-2/+1
| | | | | | GH-95913: Add the release date for Python 3.11 (GH-109750) (cherry picked from commit b10de68c6ceae1076cdc98c890b9802dc81a7f44) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] Docs: Update Donghee Na's name (GH-109743) (#109759)Hugo van Kemenade2023-09-234-31/+31
| | | | | | | * Update Donghee Na's name in Docs/ * Update Donghee Na's name in Misc/ACKS * Update Donghee Na's name in Misc/NEWS.d/
* [3.11] GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (#109637)Miss Islington (bot)2023-09-212-7/+5
| | | | | | GH-109209: Bump the minimum Sphinx version to 4.2 (GH-109210) (cherry picked from commit 712cb173f8e1d02c625a40ae03bba57b0c1c032a) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
* [3.11] Fix typos in docs and comments (#109619) (#109622)Alex Waygood2023-09-202-2/+2
| | | Co-authored-by: Heinz-Alexander Fuetterer <35225576+afuetterer@users.noreply.github.com>
* [3.11] gh-108973: Fix asyncio SubprocessProtocol doc (#109431) (#109610)Victor Stinner2023-09-202-6/+23
| | | | | | | | | | gh-108973: Fix asyncio SubprocessProtocol doc (#109431) SubprocessProtocol process_exited() method can be called before pipe_data_received() and pipe_connection_lost() methods. Document it and adapt the example in the doc. Co-authored-by: Davide Rizzo <sorcio@gmail.com> (cherry picked from commit ced6924630037f1e5b3d1dbef2b600152fb07fbb)
* [3.11] Fix extraneous backslashes in hashlib docs (GH-109468) (#109531)Miss Islington (bot)2023-09-181-12/+12
| | | | | | Fix extraneous backslashes in hashlib docs (GH-109468) (cherry picked from commit ce5b3e19e6fb940fa72db1b98a8df80f6e464265) Co-authored-by: Anthony Sottile <asottile@umich.edu>
* [3.11] gh-109451: Fix wrong format specifier in logging documentation ↵Miss Islington (bot)2023-09-161-1/+1
| | | | | (GH-109465) (GH-109482) (cherry picked from commit 929cc4e4a0999b777e1aa94f9c007db720e67f43)
* [3.11] gh-109414: Add some basic information about venvs in the ↵Miss Islington (bot)2023-09-161-0/+19
| | | | | introduction. (GH-109440) (GH-109480) (cherry picked from commit a6846d45ff3c836bc859c40e7684b57df991dc05)
* [3.11] gh-109474: Update two Unix packaging URLs (GH-109307) (#109478)Miss Islington (bot)2023-09-161-2/+2
| | | | | | | | | | gh-109474: Update two Unix packaging URLs (GH-109307) update packaging URLs fix a broken URL for fedora RPM packaging guide and fix a URL redirect for Slackware packaging guide. (cherry picked from commit 0b38ce440bd76b3d25b6d042ee9613841fb4a947) Co-authored-by: partev <petrosyan@gmail.com>
* [3.11] Docs: Superseded modules: list only module names (GH-109439) (#109446)Miss Islington (bot)2023-09-151-0/+1
| | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-101100: Fix sphinx warnings in `turtle.rst` (GH-109394) (#109417)Miss Islington (bot)2023-09-142-5/+4
| | | | | (cherry picked from commit 21e80f4c1925aaafae199840f8737b5c39a82c70) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] GH-104395: Add a link in 'Meta Information' to the docs download page ↵Miss Islington (bot)2023-09-121-0/+1
| | | | | | | (GH-104443) (#109346) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-109184: update traceback module doc w.r.t notes (message is no ↵Irit Katriel2023-09-121-20/+21
| | | | | | | longer always at the end) (#109201) (#109336) gh-109184: update traceback module doc w.r.t notes (message is no longer always at the end) (#109201) (cherry picked from commit 0e76cc359ba5d5e29d7c75355d7c1bc7e817eecf)
* [3.11] gh-107322: zipapp: Remove the suggestion to remove .dist-info ↵Miss Islington (bot)2023-09-121-6/+1
| | | | | | directories (GH-107296) (#109282) Co-authored-by: wim glenn <hey@wimglenn.com>
* [3.11] gh-107924: re-order os.sendfile() flag documentation (#107926) (#109178)Hugo van Kemenade2023-09-091-15/+15
| | | | | Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
* [3.11] gh-108682: [Enum] raise TypeError if super().__new__ called in custom ↵Ethan Furman2023-09-081-1/+22
| | | | | | | | | | | | | __new__ (GH-108704) (GH-108739) When overriding the `__new__` method of an enum, the underlying data type should be created directly; i.e. . member = object.__new__(cls) member = int.__new__(cls, value) member = str.__new__(cls, value) Calling `super().__new__()` finds the lookup version of `Enum.__new__`, and will now raise an exception when detected. (cherry picked from commit d48760b2f1e28dd3c1a35721939f400a8ab619b8)
* [3.11] gh-102823: Document return type of floor division on floats ↵Miss Islington (bot)2023-09-071-3/+5
| | | | | | | (GH-102824) (#109093) Co-authored-by: Mark Dickinson <dickinsm@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-71770: Add more details on behavior of configparser's ↵Miss Islington (bot)2023-09-071-2/+4
| | | | | | | default_section (GH-31562) (#109089) Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] GH-90915: Document that SystemExit doesn't trigger sys.excepthook ↵Miss Islington (bot)2023-09-071-1/+1
| | | | | | | | (GH-31357) (#109083) Co-authored-by: Colin Watson <cjwatson@debian.org> Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] socket documentation fix - rename triple to 3-tuple (GH-24722) (#109074)Miss Islington (bot)2023-09-071-2/+2
| | | | | Co-authored-by: Ori Hoch <ori@uumpa.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] bpo-38157: Add example about per file output for mock_open. ↵Miss Islington (bot)2023-09-071-0/+24
| | | | | | | | | (GH-16090) (#109072) Co-authored-by: Karthikeyan Singaravelan <tir.karthi@gmail.com> Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-107755: Document the correct default value of slice step ↵Miss Islington (bot)2023-09-071-1/+1
| | | | | | | | | | (GH-107756) (#108956) gh-107755: Document the correct default value of slice step (GH-107756) Document the correct default value of slice step. (cherry picked from commit 9bf350b0662fcf1a8b43b9293e6c8ecf3c711561) Co-authored-by: wim glenn <hey@wimglenn.com>
* [3.11] GH-108202: Document ``calendar``'s command-line interface (GH-109020) ↵Miss Islington (bot)2023-09-071-0/+143
| | | | | | | | | (#109031) GH-108202: Document ``calendar``'s command-line interface (GH-109020) (cherry picked from commit f0f96a9f40762499811681d405b6f922b6ed7a55) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-108857: improve markup in inspect.Signature.replace() docs ↵Miss Islington (bot)2023-09-061-1/+1
| | | | | | | | (GH-108862) (#108970) gh-108857: improve markup in inspect.Signature.replace() docs (GH-108862) (cherry picked from commit 6f8411cfd68134ccae01b0b4cb332578008a69e3) Co-authored-by: nabin2004 <107109731+nabin2004@users.noreply.github.com>
* [3.11] gh-101100: Fix sphinx warnings in `unittest.mock-examples.rst` ↵Nikita Sobolev2023-09-022-7/+7
| | | | | (GH-108810) (#108812) (cherry picked from commit 5141b1ebe07ad54279e0770b4704eaf76f24951d)
* [3.11] gh-101100: Fix sphinx warnings in `uuid.rst` (GH-108805) (#108808)Miss Islington (bot)2023-09-022-22/+30
| | | | | | | (cherry picked from commit 21da4980f5916e8fd648f04367a9e60d141af366) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.11] Improve some C API documentation (GH-108768) (GH-108786)Serhiy Storchaka2023-09-023-44/+43
| | | | | | | | * Express functions which take argument as a C string in terms of functions which take Python object. * Use "note" directive for PyMapping_HasKey() and PyMapping_HasKeyString() notes. (cherry picked from commit 6f97eeec222f81bd7ae836c149872a40b079e2a6)
* [3.11] gh-105563: reference DateType in datetime's documentation (GH-105946) ↵Miss Islington (bot)2023-09-011-0/+4
| | | | | | | | (#108790) gh-105563: reference DateType in datetime's documentation (GH-105946) (cherry picked from commit 8f9ea43ee805f98391f857397daac9df7ffa71cd) Co-authored-by: TATHAGATA ROY <royzen9495@gmail.com>
* [3.11] gh-101100: Fix sphinx warnings in `tutorial/appendix.rst` (GH-108750) ↵Miss Islington (bot)2023-09-012-5/+4
| | | | | | | (#108757) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-101100: Fix sphinx warnings in `tutorial/classes.rst` (GH-108746) ↵Miss Islington (bot)2023-09-012-2/+1
| | | | | | (#108755) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.11] gh-104372: Drop the GIL around the vfork() call. (#104782) (#104958)Gregory P. Smith2023-09-011-5/+8
| | | | | | | | | | | | | gh-104372: Drop the GIL around the vfork() call. (#104782) On Linux where the `subprocess` module can use the `vfork` syscall for faster spawning, prevent the parent process from blocking other threads by dropping the GIL while it waits for the vfork'ed child process `exec` outcome. This prevents spawning a binary from a slow filesystem from blocking the rest of the application. Fixes #104372. (cherry picked from commit d08679212d9af52dd074cd4a6abb440edb944c9c)
* [3.11] `ast` docs: Fix incorrect link on `keyword` (GH-108728) (#108738)Miss Islington (bot)2023-08-311-2/+2
| | | | | | | | `ast` docs: Fix incorrect link on `keyword` (GH-108728) In two places, Sphinx was erroneously adding links to the `keyword` module instead of the `ast.keyword` class (cherry picked from commit c1e2f3b2f70b8a72ea7e1bf792addf62a94ae65d) Co-authored-by: Alex Povel <git@alexpovel.de>
* [3.11] gh-101100: Fix sphinx warnings in `threading.rst` (GH-108684) (#108708)Miss Islington (bot)2023-08-312-9/+8
| | | | | Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
* [3.11] gh-101100: Fix Sphinx warnings in the Logging Cookbook (GH-108678) ↵Miss Islington (bot)2023-08-302-5/+11
| | | | | | (#108681) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>