summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
* [3.12] typing docs: fix indentation of TypedDict deprecation notice (#120124)Alex Waygood2024-06-051-3/+3
|
* [3.12] gh-119287: clarify doc on BaseExceptionGroup.derive and link to it ↵Miss Islington (bot)2024-06-052-2/+5
| | | | | | | | from contextlib.suppress (GH-119657) (#120106) gh-119287: clarify doc on BaseExceptionGroup.derive and link to it from contextlib.suppress (GH-119657) (cherry picked from commit 5c02ea8bae2287a828840f5734966da23dc573dc) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.12] gh-120078: Fix struct_time attr typo tm_day -> tm_mday in ↵Miss Islington (bot)2024-06-051-1/+1
| | | | | | | Doc/library/time.rst (GH-120084) (cherry picked from commit b6b0dcbfc054f581b6f78602e4c2e9474e3efe21) Co-authored-by: shurj0 <60540027+shurj0@users.noreply.github.com>
* [3.12] gh-119311: Fix name mangling with PEP 695 generic classes (#119464) ↵Jelle Zijlstra2024-06-041-1/+4
| | | | | | | | | | (#119644) * [3.12] gh-119311: Fix name mangling with PEP 695 generic classes (#119464) Fixes #119311. Fixes #119395. (cherry picked from commit a9a74da4a0ca0645f049e67b6434a95e30592c32)
* [3.12] GH-119054: Add "Reading and writing files" section to pathlib docs ↵Barney Gale2024-06-021-76/+81
| | | | | | | | (GH-119524) (#119955) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`. (cherry picked from commit bd6d4ed6454378e48dab06f50a9be0bae6baa3a2)
* [3.12] GH-119054: Add "Querying file type and status" section to pathlib ↵Barney Gale2024-06-021-145/+151
| | | | | | | | docs (GH-119055) (#119952) Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`. (cherry picked from commit 81d63362302187e5cb838c9a7cd857181142e530)
* [3.12] Improve documentation for typing.get_type_hints (GH-119928) (#119944)Miss Islington (bot)2024-06-021-26/+28
| | | | | | | | | | | | | | | - Explicit list of what it does that is different from "just return __annotations__" - Remove reference to PEP 563; adding the future import doesn't do anything to type aliases, and in general it will never make get_type_hints() less likely to fail. - Remove example, as the Annotated docs already have a similar example, and it's unbalanced to have one example about this one edge case but not about other behaviors of the function. (cherry picked from commit aa9fe98e0649f0a151942914ef4e2810ca6126c2) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] gh-119016: Remove outdated sentences from the "classes" tutorial ↵Miss Islington (bot)2024-06-011-5/+1
| | | | | | | (GH-119130) (#119926) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] Add unique() recipe to itertools docs (gh-119911) (gh-119917)Miss Islington (bot)2024-06-011-2/+14
|
* [3.12] contextlib docs: Clean up redundant 'up' after 'cleanup' (GH-119873)Miss Islington (bot)2024-05-311-1/+1
| | | | Reported by Michael Kass on docs@ (cherry picked from commit f3fc800d5f17b144a752a262102b750bedcdaa14)
* [3.12] gh-100117: Fix inaccuracy in documentation of the CodeObject's ↵Miss Islington (bot)2024-05-311-1/+1
| | | | | | | | co_positions field. (GH-119364) (#119870) gh-100117: Fix inaccuracy in documentation of the CodeObject's co_positions field. (GH-119364) (cherry picked from commit 015b1fdd0ae03f94a5dfda051b020810d1c952dd) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.12] gh-109218: Improve documentation for the complex() constructor ↵Serhiy Storchaka2024-05-302-57/+123
| | | | | | | | | | | | | | | | (GH-119687) (ПР-119805) * Remove the equivalence with real+imag*1j which can be incorrect in corner cases (non-finite numbers, the sign of zeroes). * Separately document the three roles of the constructor: parsing a string, converting a number, and constructing a complex from components. * Document positional-only parameters of complex(), float(), int() and bool() as positional-only. * Add examples for complex() and int(). * Specify the grammar of the string for complex(). * Improve the grammar of the string for float(). * Describe more explicitly the behavior when real and/or imag arguments are complex numbers. (This will be deprecated in future.) (cherry picked from commit ec1ba264607b2b7b98d2602f5536a1d02981efc6)
* [3.12] gh-119779: Fix pyporting howto docs (GH-119785) (#119789)Miss Islington (bot)2024-05-301-2/+2
| | | | | | gh-119779: Fix pyporting howto docs (GH-119785) (cherry picked from commit 6fb191be15fd49da10506de29b6393ffdf59b894) Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
* [3.12] gh-118055: Update the finder glossary entry (GH-118278) (GH-119774)Miss Islington (bot)2024-05-301-2/+2
| | | | | | gh-118055: Update the finder glossary entry (GH-118278) (cherry picked from commit db009348b4b7a4b0aec39472ea074c1b5feeba9b) Co-authored-by: Lincoln <71312724+Lincoln-developer@users.noreply.github.com>
* [3.12] subprocess docs: Fix semantically important typo (GH-119752) (#119758)Miss Islington (bot)2024-05-301-1/+1
| | | | | | | | | | subprocess docs: Fix semantically important typo (GH-119752) GH-25416 accidentally replaced a reference to the *stderr* argument of `subprocess.run` with a reference to the *stdin* argument. *stdin* is not affected by the `check_output` option. (cherry picked from commit 2cc3502f98bb9aea386ab55443fc077ddcdde91d) Co-authored-by: Zachary Ware <zach@python.org>
* [3.12] gh-119260: Clarify is_dataclass Behavior for Subclasses in ↵Miss Islington (bot)2024-05-301-2/+2
| | | | | | | | | Documentation and Tests (GH-119480) (#119761) gh-119260: Clarify is_dataclass Behavior for Subclasses in Documentation and Tests (GH-119480) (cherry picked from commit bf4ff3ad2e362801e87c85fffd9e140b774cef26) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com> Co-authored-by: Carl Meyer <carl@oddbird.net>
* [3.12] Clarify base64.a85encode docs: *wrapcols* doesn't count the newline ↵Miss Islington (bot)2024-05-281-1/+1
| | | | | | | | (GH-119409) (GH-119482) Clarify base64.a85encode docs: *wrapcols* doesn't count the newline (GH-119409) (cherry picked from commit ffa24aab107b5bc3c6ad31a6a245c226bf24b208) Co-authored-by: Petr Viktorin <encukou@gmail.com>
* [3.12] [doc] Clarify the nature of the root logger in the `logging` ↵Miss Islington (bot)2024-05-281-9/+11
| | | | | documentation (GH-119440) (GH-119652) (cherry picked from commit b407ad38fb93585332c370b8fa56905fb238cdfd)
* [3.12] Misc cleanups and wording improvements for the itertools docs (gh-119631)Raymond Hettinger2024-05-271-122/+116
|
* [3.12] gh-119580: Improve version added section for convenience variable ↵Miss Islington (bot)2024-05-271-0/+2
| | | | | | (GH-119583) (#119625) Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
* [3.12] Docs: Only install sphinx-autobuild for `make htmllive` (GH-119607) ↵Miss Islington (bot)2024-05-272-2/+5
| | | | | | (#119622) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-119467: Fix Py_buffer.format type and correct documentation typo ↵Miss Islington (bot)2024-05-271-2/+2
| | | | | | | | (GH-119475) (#119603) gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475) (cherry picked from commit 3b26cd8ca0e6c65e4b61effea9aa44d06e926797) Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
* [3.12] docs: fix a few typos identified by codespell (GH-119516) (#119571)Hugo van Kemenade2024-05-2617-21/+21
| | | | Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.12] FAQ: Add reference to Python version numbering scheme (GH-119225) ↵Miss Islington (bot)2024-05-251-2/+2
| | | | | | (#119545) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] Misc improvements to the docs for itertools (gh-119532)Raymond Hettinger2024-05-241-55/+55
|
* [3.12] Regen ``Doc/requirements-oldest-sphinx.txt`` (GH-119520) (#119523)Miss Islington (bot)2024-05-241-1/+1
| | | | Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* [3.12] gh-119317: findall instead of traverse for docutils nodes (GH-119319) ↵Miss Islington (bot)2024-05-242-4/+4
| | | | | | | | (#119487) gh-119317: findall instead of traverse for docutils nodes (GH-119319) (cherry picked from commit 0867bce45768454ee31bee95ca33fdc2c9d8b0fa) Co-authored-by: Carlos Meza <hire@carlosmeza.com>
* [3.12] gh-90562: Mention slots pitfall in dataclass docs (GH-107391) (#119351)Miss Islington (bot)2024-05-231-1/+4
| | | | | | | | Co-authored-by: Josh Cannon <joshdcannon@gmail.com> Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com> Co-authored-by: Erlend E. Aasland <erlend@python.org> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.12] gh-119213: Be More Careful About _PyArg_Parser.kwtuple Across ↵Eric Snow2024-05-221-868/+893
| | | | | | | | | | | Interpreters (gh-119331) (gh-119425) _PyArg_Parser holds static global data generated for modules by Argument Clinic. The _PyArg_Parser.kwtuple field is a tuple object, even though it's stored within a static global. In some cases the tuple is statically allocated and thus it's okay that it gets shared by multiple interpreters. However, in other cases the tuple is set lazily, allocated from the heap using the active interprepreter at the point the tuple is needed. This is a problem once that interpreter is destroyed since _PyArg_Parser.kwtuple becomes at dangling pointer, leading to crashes. It isn't a problem if the tuple is allocated under the main interpreter, since its lifetime is bound to the lifetime of the runtime. The solution here is to temporarily switch to the main interpreter. The alternative would be to always statically allocate the tuple. This change also fixes a bug where only the most recent parser was added to the global linked list. (cherry picked from commit 81865002aee8eaaeb3c7e402f86183afa6de77bf)
* [3.12] gh-70795: Rework RLock documentation (GH-103853) (#119437)Miss Islington (bot)2024-05-221-24/+51
| | | | | | | | | | | | | | | | | | | | | gh-70795: Rework RLock documentation (GH-103853) Attempted to simultaneously reduce verbosity, while more descriptively describing behavior. Fix links (RLock acquire/release previously linking to Lock acquire/release, seems like bad copy pasta). Add a seealso for with-locks. Switch section to use bullet points. --------- (cherry picked from commit 2fbea81d646688cf438be1dc0be82112a9ae4325) Co-authored-by: uıɐɾ ʞ ʇɐɯɐs <_@skj.io> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com> Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
* [3.12] Fix version number in use_load_tests deprecation reference ↵Miss Islington (bot)2024-05-221-1/+1
| | | | | | | | (GH-119151) (GH-119387) Deprecation took place in d78742a260ba09e53c844de7b1fd11a11c674945 (3.5) (cherry picked from commit aee8f03abbebfb76357f459dfb297026862e3c0b) Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [3.12] Clarify that dklen is expected in bytes for the hashlib functions ↵Miss Islington (bot)2024-05-221-2/+2
| | | | | | | (GH-106624) (GH-119384) (cherry picked from commit 5adf78f546a5dc3f5b8eeaa209a2e8437ae96ac8) Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
* [3.12] gh-110383: Align dict.get(), .fromkeys(), and .setdefault() docs with ↵Miss Islington (bot)2024-05-221-3/+3
| | | | | | | docstrings (GH-119330) (#119371) (cherry picked from commit 0e3c8cda1f04c983994e76aea93600dbb4714832) Co-authored-by: Landon Wood <landon@elkrange.com>
* [3.12] gh-110383: Document `socket.makefile()` accepts combined modes ↵Miss Islington (bot)2024-05-211-1/+2
| | | | | | | | (GH-119150) (#119325) The supported mode values are 'r', 'w', and 'b', or a combination of those. (cherry picked from commit 62a29be5bb01c2d0f72d8f9b1b5539816e65310c) Co-authored-by: Daniel Williams <dann0a@gmail.com>
* [3.12] GH-110383: Improve Tutorial for Input Ouput (GH-119230) (GH-119327)Miss Islington (bot)2024-05-211-4/+16
| | | | | | | | GH-110383: Improve Tutorial for Input Ouput (GH-119230) (cherry picked from commit 9db2fd7edaa9d03e8c649c3bb0e8d963233cde22) Co-authored-by: Blaise Pabon <blaise@gmail.com> Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
* [3.12] Docs: Ensure no warnings are found in the NEWS file before a given ↵Hugo van Kemenade2024-05-211-0/+40
| | | | line number (GH-119221) (#119266)
* [3.12] gh-118912: Remove description of issue fixed in 3.5 from autospeccing ↵Miss Islington (bot)2024-05-201-32/+8
| | | | | | | | | | | | | | | | | | guide (GH-119232) (#119283) gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232) * Remove description of issue fixed in 3.5 from autospeccing guide * Make autospeccing note text more succint and lint whitespace * Add linting changes (missed in last commit) --------- (cherry picked from commit 7e57640c7ec6b7b5ce9b5eac465f6b771fd6ae69) Co-authored-by: Shauna <shaunagm@gmail.com> Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
* [3.12] gh-108267 Fix another dataclasses docs typo (GH-119277) (#119280)Miss Islington (bot)2024-05-201-1/+2
| | | | | | gh-108267 Fix another dataclasses docs typo (GH-119277) (cherry picked from commit 423bbcbbc43cacfb6a217c04f890a47d3cf7c3a9) Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.12] Use correct markup in unittest.mock.reset_mock documentation ↵Miss Islington (bot)2024-05-201-3/+3
| | | | | | | | (GH-119207) (GH-119249) Use correct markup in unittest.mock.reset_mock documentation (GH-119207) (cherry picked from commit 6b80a5b20f31a067bd1c374295608df5f1210f49) Co-authored-by: Tialo <65392801+Tialo@users.noreply.github.com>
* [3.12] DOCS: Suggest always calling exec with a globals argument and no ↵Miss Islington (bot)2024-05-201-3/+7
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | locals argument (GH-119235) (#119240) DOCS: Suggest always calling exec with a globals argument and no locals argument (GH-119235) Many users think they want a locals argument for various reasons but they do not understand that it makes code be treated as a class definition. They do not want their code treated as a class definition and get surprised. The reason not to pass locals specifically is that the following code raises a `NameError`: ```py exec(""" def f(): print("hi") f() def g(): f() g() """, {}, {}) ``` The reason not to leave out globals is as follows: ```py def t(): exec(""" def f(): print("hi") f() def g(): f() g() """) ``` (cherry picked from commit 7e1a130b8ff1ed8b3a5f00fe0f06d3916b852216) Co-authored-by: Hood Chatham <roberthoodchatham@gmail.com>
* [3.12] marshal docs: Remove reference to "Sun" (GH-119161) (#119168)Miss Islington (bot)2024-05-191-1/+1
| | | | | | | | Nobody has been using a Sun machine for a long time. When I saw this sentence in a lightning talk just now, I thought it was talking about sending Python code on a spacecraft. (cherry picked from commit 697465ff88e49d98443025474e5b534adfba2cb0) Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.12] gh-119078: Clarify venv tutorial (GH-119129) (GH-119141)Miss Islington (bot)2024-05-181-4/+4
| | | (cherry picked from commit 0f5e8bed636c2f29701e5a1965d1b088d33abbf0)
* [3.12] Minor improvements to the docs for itertools.tee() (gh-119135) ↵Miss Islington (bot)2024-05-181-10/+11
| | | | (gh-119137)
* [3.12] gh-108267: Fix object.__setattr__ regression in dataclasses docs ↵Miss Islington (bot)2024-05-161-1/+2
| | | | | | (GH-119082) (#119098) Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
* [3.12] gh-119009: Add gettext target (GH-119006) (#119075)Miss Islington (bot)2024-05-152-0/+8
| | | | Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
* [3.12] Misc improvements to the itertools docs (gh-119040) (#119044)Miss Islington (bot)2024-05-141-35/+26
|
* [3.12] Itertools docs: fix parameter names and indentation in Python ↵Miss Islington (bot)2024-05-141-5/+5
| | | | equivalents (gh-118977) (#119042)
* [3.12] gh-119010: Adds docs about `__type_params__` to ↵Miss Islington (bot)2024-05-131-2/+6
| | | | | | | | | `functools.update_wrapper` (GH-119012) (#119014) gh-119010: Adds docs about `__type_params__` to `functools.update_wrapper` (GH-119012) (cherry picked from commit b04c497f187b0b474e431a6d8d282269b40ffe52) Co-authored-by: Nikita Sobolev <mail@sobolevn.me> Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
* [3.12] Improve the `rmtree` doc for `dir_fd` param addition in 3.11 ↵Miss Islington (bot)2024-05-131-1/+1
| | | | | | (GH-118964) (#118992) Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
* [3.12] GH-118701: Note that recursive wildcards aren't supported in ↵Barney Gale2024-05-111-0/+4
| | | | `PurePath.match()` (#118713)
generated by cgit v0.12 at 2024-10-06 21:15:23 (GMT)