aboutsummaryrefslogtreecommitdiff
path: root/Doc
AgeCommit message (Collapse)Author
2023-06-05[3.11] gh-89412: Add missing attributes (added in 3.10) to traceback module ↵Miss Islington (bot)
docs (GH-105046) (#105328) (cherry picked from commit a4f72fa39a9d391c7b931ba1906d81da4ae01949) Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-06-04[3.11] gh-104882: Docs: fix description of relationship between ↵Miss Islington (bot)
`socket.getblocking()` and `socket.gettimeout()` (GH-105026) (#105284) gh-104882: Docs: fix description of relationship between `socket.getblocking()` and `socket.gettimeout()` (GH-105026) (cherry picked from commit 5a5ed7a3e616a372f054a1dd2e9a31ba32a87a67) Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
2023-06-02[3.11] gh-105184: document that marshal functions can fail and need to be ↵Miss Islington (bot)
checked with PyErr_Occurred (GH-105185) (#105219) gh-105184: document that marshal functions can fail and need to be checked with PyErr_Occurred (GH-105185) (cherry picked from commit ee26ca13a129da8cf549409d0a1b2e892ff2b4ec) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-05-31[3.11] gh-105096: Reformat wave documentation (#105136) (#105138) (#105155)Victor Stinner
[3.12] gh-105096: Reformat wave documentation (#105136) (#105138) gh-105096: Reformat wave documentation (#105136) Add ".. class::" markups in the wave documentation. * Reformat also wave.py (minor PEP 8 changes). * Remove redundant "import struct": it's already imported at top level. * Remove wave.rst from .nitignore (cherry picked from commit 85e5d03163cac106ac8ec142ef03f1349a48948b) (cherry picked from commit 01b42f9559b614d729c3f055d09269db13d2433c)
2023-05-29[3.11] GH-89455: Add missing attributes (added in 3.11) to traceback module ↵Miss Islington (bot)
docs (GH-105044) (#105067) GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044) (cherry picked from commit 39f6a0489fcc815a578d27dfee2feea003c896f8) Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-05-27[3.11] gh-103921: Improve typing documentation (GH-104642) (#105007)Jelle Zijlstra
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-26[3.11] gh-104992: [What's New in 3.11] Document ↵Miss Islington (bot)
unittest.TestProgram.usageExit's deprecation (GH-104994) (#105010) gh-104992: [What's New in 3.11] Document unittest.TestProgram.usageExit's deprecation (GH-104994) Document unittest.TestProgram.usageExit's pending removal in 3.13 (cherry picked from commit 7df861c23cd61e7c55943d4036ea5c6b1df5cb49) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-05-26[3.11] gh-104984: remove kwargs and starargs from Call & ClassDef ↵Miss Islington (bot)
(GH-104986) (#104988) gh-104984: remove kwargs and starargs from Call & ClassDef (GH-104986) These fields are removed in https://github.com/python/cpython/commit/025e9ebd0a0a19f50ca83af6ada0ac65be1fa2a1 (cherry picked from commit 61c1d6760facbc172a58512cad46148f587b4da1) Co-authored-by: Shaygan Hooshyari <sh.hooshyari@gmail.com>
2023-05-26[3.11] gh-104479: Update outdated tutorial floating-point reference ↵Shantanu
(GH-104681) (#104961) (cherry picked from commit 2cf04e455d8f087bd08cd1d43751007b5e41b3c5) Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-05-25[3.11] gh-104874: Document NewType.__supertype__ (GH-104875) (#104907)Miss Islington (bot)
gh-104874: Document NewType.__supertype__ (GH-104875) (cherry picked from commit 41768a2bd3a8f57e6ce4e4ae9cab083b69817ec1) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-22[3.11] howto/urllib2: remove link to an outdated french translation ↵Miss Islington (bot)
(GH-104193) (GH-104746) howto/urllib2: remove link to an outdated french translation (GH-104193) We now have our own translation and it's not outdated (cherry picked from commit 151b6bfb5d9a15b6e2682e5a3008a3f9ec3086ae) Co-authored-by: Mathieu Dupuy <deronnax@gmail.com>
2023-05-21[3.11] gh-103606: Improve error message from logging.config.FileConfig ↵Prince Roshan
(GH-103628) (#104687) * gh-103606: Improve error message from logging.config.FileConfig (GH-103628) (cherry picked from commit 152227b569c3a9b87fe0483706f704762ced6d75) plus backport the followup exception change fix to that in #104701
2023-05-21[3.11] typing docs: Move some classes out of the "Generics" section ↵Jelle Zijlstra
(GH-104707) (#104721) - AnyStr can be used in type annotations, contrary to the section header - Unpack can also be used in annotations, and its use is not restricted to generics. It makes more sense with other building blocks like Required. - Protocol is not necessarily generic. Also fix the indentation for two notes associated with Concatenate. (cherry picked from commit ab71acd67b5b09926498b8c7f855bdb28ac0ec2f) --------- Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-21[3.11] Corrected identifier (GH-104713) (#104714)Miss Islington (bot)
Corrected identifier (GH-104713) (cherry picked from commit 60993ba8b4a04dfcf2d3067d919bcce160f01bd5) Co-authored-by: William Sawyer <wmsawyer2609@gmail.com>
2023-05-20[3.11] gh-49174: document that the effect of calling gc.collect() during a ↵Miss Islington (bot)
collection is undefined (GH-104699) (#104703) gh-49174: document that the effect of calling gc.collect() during a collection is undefined (GH-104699) (cherry picked from commit 30488fa22a8f63753192ae7f1d01665857764e45) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-05-20[3.11] gh-104679 Fixed syntax highlighting in turtle docs (GH-104682). (#104695)han-solo
(cherry picked from commit 2c97878bb8a09f5aba8bf413bb794f6efd5065df)
2023-05-19[3.11] docs: fix wrong indentation causing rendering error in dis page ↵Miss Islington (bot)
(GH-104661) (#104670) docs: fix wrong indentation causing rendering error in dis page (GH-104661) (cherry picked from commit 3bc94e678f2961eafc9d665898d73afc6204d314) Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>
2023-05-19[3.11] gh-104659: Consolidate python examples in enum documentation ↵Hugo van Kemenade
(#104665) (#104666) gh-104659: Consolidate python examples in enum documentation (#104665) (cherry picked from commit 3ac856e69734491ff8423020c700c9ae86ac9a08) Co-authored-by: Thomas Hisch <t.hisch@gmail.com>
2023-05-17[3.11] gh-102153: Start stripping C0 control and space chars in `urlsplit` ↵Miss Islington (bot)
(GH-102508) (#104575) * gh-102153: Start stripping C0 control and space chars in `urlsplit` (GH-102508) `urllib.parse.urlsplit` has already been respecting the WHATWG spec a bit GH-25595. This adds more sanitizing to respect the "Remove any leading C0 control or space from input" [rule](https://url.spec.whatwg.org/GH-url-parsing:~:text=Remove%20any%20leading%20and%20trailing%20C0%20control%20or%20space%20from%20input.) in response to [CVE-2023-24329](https://nvd.nist.gov/vuln/detail/CVE-2023-24329). --------- (cherry picked from commit 2f630e1ce18ad2e07428296532a68b11dc66ad10) Co-authored-by: Illia Volochii <illia.volochii@gmail.com> Co-authored-by: Gregory P. Smith [Google] <greg@krypto.org>
2023-05-16[3.11] gh-104539: Fix indentation error in logging.config.rst (GH-104545) ↵Miss Islington (bot)
(#104546) gh-104539: Fix indentation error in logging.config.rst (GH-104545) Fix indentation error in logging.config.rst (cherry picked from commit 0bb61dd5b0ffc248e18f1b33cddd18788f28e60a) Co-authored-by: Jesper Noordsij <45041769+jnoordsij@users.noreply.github.com>
2023-05-15[3.11] gh-67056: document that registering/unregistering an atexit func from ↵Miss Islington (bot)
within an atexit func is undefined (GH-104473) (#104500)
2023-05-14[3.11] gh-104337: Clarify random.gammavariate doc entry (GH-104410) (#104481)Miss Islington (bot)
(cherry picked from commit 88c5c586708dcff369c49edae947d487a80f0346) Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-05-14[3.11] Minor improvements to typing docs (GH-104465) (#104475)Miss Islington (bot)
Minor improvements to typing docs (GH-104465) (cherry picked from commit 2f7b5e458e9189fa1ffd44339848aa1e52add3fa) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-13[3.11] Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) ↵Miss Islington (bot)
(#104447) Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) (cherry picked from commit 1be80ed107deb15b926f2794b8e6a7a527b8b84c) Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2023-05-11[3.11] gh-101117: Improve accuracy of sqlite3.Cursor.rowcount docs (#104287) ↵Erlend E. Aasland
(#104381) The SQLite C API sqlite3_changes() can only be relied upon when the current active statement has been run to completion.
2023-05-10[3.11] gh-104010: Separate and improve docs for `typing.get_origin` and ↵Miss Islington (bot)
`typing.get_args` (GH-104013) (#104359) * separate documentation and examples for both functions * add examples demonstrating behaviour with unsupported types * document return value of `get_origin` for `ParamSpecArgs` and `ParamSpecKwargs` instances (cherry picked from commit a7a2dbbf72aceef61bfb50901bfa39bfb8d6d229) Co-authored-by: chgnrdv <52372310+chgnrdv@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-10[3.11] gh-103960: Dark mode: invert image brightness (GH-103983) (#104358)Miss Islington (bot)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-05-10[3.11] gh-48241: Clarify URL needs to be encoded when provided to urlopen ↵Miss Islington (bot)
and Request (GH-103855) (#103891) (cherry picked from commit 44010d0f1203134cd8f885ca574caaef373e80f6) Co-authored-by: Michael Blahay <mblahay@users.noreply.github.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-05-09[3.11] gh-102327: Extend docs for "url" and "headers" parameters to ↵Miss Islington (bot)
HTTPConnection.request() gh-102327: Extend docs for "url" and "headers" parameters to HTTPConnection.request() Added example on how to use the HTTPConnection object for making GET request. Original issue: https://github.com/python/cpython/issues/102327 --------- (cherry picked from commit 7ba6288feb961fcd60a29415c6371d2d3eb80bec) Co-authored-by: David Foster <david@dafoster.net> Co-authored-by: Éric <earaujo@caravan.coop>
2023-05-09[3.11] [doc] logging.rst - Change link to point directly to the Google ↵Miss Islington (bot)
Group. (GH-93390) (GH-104318) (cherry picked from commit e6e81602f49a9bff51e2049c7bad60d1acb18d3f)
2023-05-09[3.11] gh-102500: collections.abc.Buffer doesn't exist in 3.11 (#104317)Shantanu
2023-05-08[3.11] GH-104284: Fix documentation gettext build (GH-104296) (#104299)Miss Islington (bot)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-08[3.11] GH-104145: Use fully-qualified cross reference types for the bisect ↵Miss Islington (bot)
module (GH-104172) (#104295) GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172) (cherry picked from commit 76eef552f3653179782afcc5063f10560a6e1a80) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-08[3.11] gh-102500: Remove mention of bytes shorthand (#104281) (#104288)Alex Waygood
gh-102500: Remove mention of bytes shorthand (#104281) The bytes shorthand was removed in PEP 688: https://peps.python.org/pep-0688/#no-special-meaning-for-bytes The reference to collections.abc.ByteString is also removed, since that object is deprecated (#91896) and has different semantics (#102092) Although PEP 688 is new in Python 3.12, type checkers are expected to implement the new semantics for type annotations even if users are using an older version of Python, so this docs PR is backported to Python 3.11. Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-07[3.11] gh-104254: Document the optional keyword-only "context" argument to ↵Miss Islington (bot)
Task constructor (GH-104251) (#104258) gh-104254: Document the optional keyword-only "context" argument to Task constructor (GH-104251) (This was added in 3.11. It was already documented for `create_task()`, but not for `Task()`.) (cherry picked from commit 4ee2068c34bd45eddba7f6a8ee83f62d5b6932fc) Co-authored-by: Itamar Ostricher <itamarost@gmail.com>
2023-05-06[3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) (#104221)Miss Islington (bot)
GH-97950: Use new-style index directive ('builtin') (GH-104164) * Uncomment builtin removal in pairindextypes * Use new-style index directive ('builtin') - C API * Use new-style index directive ('builtin') - Extending * Use new-style index directive ('builtin') - Library * Use new-style index directive ('builtin') - Reference * Use new-style index directive ('builtin') - Tutorial (cherry picked from commit f5088006ca8e9654fbc3de119462f0ab764e408b) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-05[3.11] gh-64658: Expand Argument Clinic return converter docs (#104175) ↵Erlend E. Aasland
(#104198)
2023-05-04[3.11] gh-104112: link from cached_property docs to method-caching FAQ ↵Miss Islington (bot)
(GH-104113) (#104182) gh-104112: link from cached_property docs to method-caching FAQ (GH-104113) (cherry picked from commit fa86a77589a06661fcebb806d36f3a7450e2aecf) Co-authored-by: Carl Meyer <carl@oddbird.net> Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-04[3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) ↵Miss Islington (bot)
(#104163) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04[3.11] GH-97950: Use new-style index directive ('exception') (GH-104160) ↵Adam Turner
(#104161)
2023-05-04[3.11] GH-97950: Use new-style index directive ('object') (GH-104158) (#104159)Miss Islington (bot)
GH-97950: Use new-style index directive ('object') (GH-104158) * Uncomment object removal in pairindextypes * Use new-style index directive ('object') - C API * Use new-style index directive ('object') - Library * Use new-style index directive ('object') - Reference * Use new-style index directive ('object') - Tutorial (cherry picked from commit 6ab463684b9d79880d98cd1f1406aa86af65985e) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04[3.11] GH-97950: Use new-style index directive ('operator') (GH-104156) ↵Miss Islington (bot)
(#104157) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04[3.11] GH-97950: Use new-style index directive ('keyword') (GH-104153) (#104155)Miss Islington (bot)
GH-97950: Use new-style index directive ('keyword') (GH-104153) * Uncomment keyword removal in pairindextypes * Use new-style index directive ('keyword') - Reference (cherry picked from commit 33ca322c50baa5152afe388fb3b8b7d63dc5a9b9) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04[3.11] GH-97950: Use new-style index directive ('module') (GH-103996) (#104154)Adam Turner
2023-05-04[3.11] GH-97950: Allow translation of index directive content (GH-104000) ↵Miss Islington (bot)
(#104151) Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-02[3.11] gh-101100: Fix Sphinx warnings in `curses` and `curses.ascii` modules ↵Miss Islington (bot)
(GH-103457) (#104124) Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02[3.11] gh-103590: do not wrap a single exception raised from a try-except* ↵Irit Katriel
(#104094)
2023-05-02[3.11] gh-65022: Fix description of tuple return value in copyreg ↵Shantanu
(GH-103892) (#104098) (cherry picked from commit 587f2f018051049cf5d9de3e12ed5aa7644404dc)
2023-05-02[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)Rafael Fontenelle
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com> Co-authored-by: Oleg Iarygin <dralife@yandex.ru> Fix redirected permanently URLs (#104001)
2023-05-02[3.11] Improve assert_type phrasing (GH-104081) (#104084)Miss Islington (bot)
Improve assert_type phrasing (GH-104081) I'd like to make the fact that this does nothing at runtime really obvious, since I suspect this is unintuitive for users who are unfamiliar with static type checking. I thought of this because of https://discuss.python.org/t/add-arg-check-type-to-types/26384 wherein I'm skeptical that the user really did want `assert_type`. (cherry picked from commit 82ba6ce303d04a7b21034e38d220e23ca9f1dc0a) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>