summaryrefslogtreecommitdiffstats
path: root/Doc
Commit message (Collapse)AuthorAgeFilesLines
...
* [3.13] gh-119287: clarify doc on BaseExceptionGroup.derive and link to it ↵Miss Islington (bot)2024-06-052-2/+5
| | | | | | | | from contextlib.suppress (GH-119657) (#120105) 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.13] 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-120085) (cherry picked from commit b6b0dcbfc054f581b6f78602e4c2e9474e3efe21) Co-authored-by: shurj0 <60540027+shurj0@users.noreply.github.com>
* [3.13] gh-114616: Improve docs regarding changes to caches representation in ↵Miss Islington (bot)2024-06-042-3/+11
| | | | | | | | dis (GH-120033) (#120079) gh-114616: Improve docs regarding changes to caches representation in dis (GH-120033) (cherry picked from commit 770f3c1eadd3392c72fd55be47770234dd143a14) Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.13] Fix incorrect pull GitHub link in What's New (GH-120045) (#120052)Miss Islington (bot)2024-06-041-1/+1
| | | | | Co-authored-by: Trey Hunner <trey@treyhunner.com> Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-119588: Update docs to reflect decision to include the change with ↵Miss Islington (bot)2024-06-041-2/+2
| | | | | | | | Python 3.13 and not 3.12. (GH-120043) (#120046) gh-119588: Update docs to reflect decision to include the change with Python 3.13 and not 3.12. (GH-120043) (cherry picked from commit 4dcd91ceafce91ec37bb1a9d544e41fc65578994) Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* [3.13] gh-119588: Implement zipfile.Path.is_symlink (zipp 3.19.0). ↵Miss Islington (bot)2024-06-041-0/+9
| | | | | | | | (GH-119591) (#119985) gh-119588: Implement zipfile.Path.is_symlink (zipp 3.19.0). (GH-119591) (cherry picked from commit 42a34ddb0b63e638905b01e17a7254623a0de427) Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
* [3.13] gh-111389: Add PyHASH_MULTIPLIER constant (GH-119214) (#119334)Miss Islington (bot)2024-06-041-0/+6
| | | | | | gh-111389: Add PyHASH_MULTIPLIER constant (GH-119214) (cherry picked from commit f6da790122fdae1a28f444edfbb55202d6829cd1) Co-authored-by: Victor Stinner <vstinner@python.org>
* [3.13] gh-119968: Improved monitoring c-api docs (GH-119969) (#119971)Miss Islington (bot)2024-06-031-1/+1
| | | | | | gh-119968: Improved monitoring c-api docs (GH-119969) (cherry picked from commit cae4c80714e7266772025676977e2a1b98cdcd7b) Co-authored-by: Awbert <119314310+SweetyAngel@users.noreply.github.com>
* [3.13] gh-109975: What's New in Python 3.13: fix broken link for `telnetlib` ↵Miss Islington (bot)2024-06-031-1/+1
| | | | | | | | alternative (GH-119958) (#119959) (cherry picked from commit 117a8acdab997b73ada822cce97815a86f839e15) Co-authored-by: Solomon Himelbloom <7608183+TechSolomon@users.noreply.github.com>
* [3.13] GH-119054: Add "Reading and writing files" section to pathlib docs ↵Miss Islington (bot)2024-06-021-79/+84
| | | | | | | | | | (GH-119524) (#119954) Add a dedicated subsection for `open()`, `read_text()`, `read_bytes()`, `write_text()` and `write_bytes()`. (cherry picked from commit bd6d4ed6454378e48dab06f50a9be0bae6baa3a2) Co-authored-by: Barney Gale <barney.gale@gmail.com>
* [3.13] GH-119054: Add "Querying file type and status" section to pathlib ↵Barney Gale2024-06-021-173/+178
| | | | | | | | docs (GH-119055) (#119951) Add a dedicated subsection for `Path.stat()`-related methods, specifically `stat()`, `lstat()`, `exists()`, `is_*()`, and `samefile()`. (cherry picked from commit 81d63362302187e5cb838c9a7cd857181142e530)
* [3.13] Improve documentation for typing.get_type_hints (GH-119928) (#119943)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.13] gh-118934: Fix PyEval_GetLocals docs (PEP 667) (GH-119934)Miss Islington (bot)2024-06-023-21/+46
| | | | | | | | | | | | | | | | PEP 667's description of the planned changes to PyEval_GetLocals was internally inconsistent when accepted, so the docs added for gh-74929 didn't match either the current behaviour or the intended behaviour once gh-118934 is fixed. This PR updates the documentation and 3.13 What's New to match the intended behaviour (once gh-118934 is fixed). It also tidies up lingering references to `f_locals` always being a dictionary (this hasn't been true since at least when custom namespace support for class statement execution was added) (cherry picked from commit fd6cd621e0cce6ba2e737103d2a62b5ade90f41f) Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
* [3.13] gh-118888: Further PEP 667 docs updates (gh-119894)Miss Islington (bot)2024-06-022-3/+44
| | | | | | | | | * Clarify impact on default behaviour of exec, eval, etc * Update documentation for changes to PyEval_GetLocals (gh-74929) Closes gh-118888 (cherry picked from commit 2180991ea3d50f56595edae241cc92dd4e7de642) Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
* [3.13] gh-119016: Remove outdated sentences from the "classes" tutorial ↵Miss Islington (bot)2024-06-011-5/+1
| | | | | | | (GH-119130) (#119925) Co-authored-by: Nice Zombies <nineteendo19d0@gmail.com> Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
* [3.13] Add unique() recipe to itertools docs (gh-119911) (gh-119916)Miss Islington (bot)2024-06-011-2/+14
|
* [3.13] gh-74929: PEP 667 C API documentation (gh-119892)Miss Islington (bot)2024-06-013-1/+85
| | | | | | | | | | | * Add docs for new APIs * Add soft-deprecation notices * Add What's New porting entries * Update comments referencing `PyFrame_LocalsToFast()` to mention the proxy instead * Other related cleanups found when looking for refs to the deprecated APIs (cherry picked from commit 3859e09e3d92d004978dd838f0511364e7edfb94) Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
* [3.13] doc: Add glossary entry for "free threading" (GH-119865) (#119874)Miss Islington (bot)2024-05-311-0/+6
| | | | | (cherry picked from commit 9bc6045842ebc91ec48ab163a9e1e8644231607c) Co-authored-by: Sam Gross <colesbury@gmail.com>
* [3.13] contextlib docs: Clean up redundant 'up' after 'cleanup' (GH-119872)Miss Islington (bot)2024-05-311-1/+1
| | | | Reported by Michael Kass on docs@ (cherry picked from commit f3fc800d5f17b144a752a262102b750bedcdaa14)
* [3.13] gh-100117: Fix inaccuracy in documentation of the CodeObject's ↵Miss Islington (bot)2024-05-311-1/+1
| | | | | | | | co_positions field. (GH-119364) (#119869) 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.13] gh-111201: Support pyrepl on Windows (GH-119559) (GH-119850)Miss Islington (bot)2024-05-311-5/+8
| | | | | | | | (cherry picked from commit 0d07182821fad7b95a043d006f1ce13a2d22edcb) Co-authored-by: Dino Viehland <dinoviehland@gmail.com> Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com> Co-authored-by: Łukasz Langa <lukasz@langa.pl>
* [3.13] Docs: `shutil.rmtree`'s `onerror` has no pending removal version ↵Miss Islington (bot)2024-05-301-3/+3
| | | | | | (GH-118947) (#119804) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-109218: Improve documentation for the complex() constructor ↵Miss Islington (bot)2024-05-302-57/+123
| | | | | | | | | | | | | | | | | | (GH-119687) (GH-119803) * 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) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] gh-119729: Use 't' in pkg-config file name for free-threaded build ↵Miss Islington (bot)2024-05-301-0/+4
| | | | | | | | | | (GH-119738) (#119797) For example, the free-threaded build now generates `lib/pkgconfig/python-3.13t.pc` and the debug build generates `lib/pkgconfig/python-3.13d.pc`. (cherry picked from commit 1c04c63ced5038e8f45a2aac7dc45f0815a4ddc5) Co-authored-by: Sam Gross <colesbury@gmail.com>
* [3.13] gh-119779: Fix pyporting howto docs (GH-119785) (#119788)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.13] gh-118055: Update the finder glossary entry (GH-118278) (GH-119773)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.13] subprocess docs: Fix semantically important typo (GH-119752) (#119757)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.13] gh-119260: Clarify is_dataclass Behavior for Subclasses in ↵Miss Islington (bot)2024-05-301-2/+2
| | | | | | | | | Documentation and Tests (GH-119480) (#119760) 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.13] Clarify base64.a85encode docs: *wrapcols* doesn't count the newline ↵Miss Islington (bot)2024-05-281-1/+1
| | | | | | | | (GH-119409) (GH-119483) 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.13] [doc] Clarify the nature of the root logger in the `logging` ↵Miss Islington (bot)2024-05-281-9/+11
| | | | | documentation (GH-119440) (GH-119651) (cherry picked from commit b407ad38fb93585332c370b8fa56905fb238cdfd)
* [3.13] gh-119317: findall instead of traverse for docutils nodes (GH-119319) ↵Miss Islington (bot)2024-05-272-4/+4
| | | | | | | | (#119486) 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.13] Docs: Move inline JavaScript to own file to reduce duplication ↵Hugo van Kemenade2024-05-272-85/+90
| | | | (GH-119541) (#119630)
* [3.13] Misc cleanups and wording improvements for the itertools docs ↵Miss Islington (bot)2024-05-271-122/+116
| | | | (gh-119626) (gh-119629)
* [3.13] gh-119580: Improve version added section for convenience variable ↵Miss Islington (bot)2024-05-271-0/+2
| | | | | | (GH-119583) (#119624) Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
* [3.13] Docs: Only install sphinx-autobuild for `make htmllive` (GH-119607) ↵Miss Islington (bot)2024-05-272-2/+5
| | | | | | (#119621) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-119467: Fix Py_buffer.format type and correct documentation typo ↵Miss Islington (bot)2024-05-271-2/+2
| | | | | | | | (GH-119475) (#119602) 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.13] docs: fix a few typos identified by codespell (GH-119516) (#119570)Miss Islington (bot)2024-05-2618-23/+23
| | | | Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
* [3.13] FAQ: Add reference to Python version numbering scheme (GH-119225) ↵Miss Islington (bot)2024-05-251-2/+2
| | | | | | (#119544) Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
* [3.13] gh-111999: Fix the signature of str.format_map() (GH-119540) (#119543)Miss Islington (bot)2024-05-251-1/+1
| | | | | (cherry picked from commit 08e65430aafa1047029e6f132a5f748c415bda14) Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
* [3.13] Misc improvement to the docs for itertools (gh-119529) (#119531)Raymond Hettinger2024-05-241-55/+55
| | | Misc improvement to the docs for itertools (gh-119529)
* [3.13] Regen ``Doc/requirements-oldest-sphinx.txt`` (GH-119520) (#119522)Miss Islington (bot)2024-05-241-1/+1
| | | | Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
* [3.13] gh-118692: Avoid creating unnecessary StopIteration instances for ↵Miss Islington (bot)2024-05-241-3/+3
| | | | | | | | | | monitoring (GH-119216) (#119497) * gh-118692: Avoid creating unnecessary StopIteration instances for monitoring (GH-119216) (cherry picked from commit 6e9863d7a3516cc76d6ce13923b15620499f3855) --------- Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
* [3.13] gh-90562: Mention slots pitfall in dataclass docs (GH-107391) (#119350)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.13] gh-70795: Rework RLock documentation (GH-103853) (#119436)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.13] gh-112066: Fix versionadded in PyDict_SetDefaultRef docs (GH-118696) ↵Miss Islington (bot)2024-05-221-0/+1
| | | | | | | (#119430) (cherry picked from commit 447edb6e987d22c91f6dfad043f3472ce07bdfc0) Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
* [3.13] Fix version number in use_load_tests deprecation reference ↵Miss Islington (bot)2024-05-221-1/+1
| | | | | | | | (GH-119151) (GH-119386) Deprecation took place in d78742a260ba09e53c844de7b1fd11a11c674945 (3.5) (cherry picked from commit aee8f03abbebfb76357f459dfb297026862e3c0b) Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
* [3.13] Clarify that dklen is expected in bytes for the hashlib functions ↵Miss Islington (bot)2024-05-221-2/+2
| | | | | | | (GH-106624) (GH-119383) (cherry picked from commit 5adf78f546a5dc3f5b8eeaa209a2e8437ae96ac8) Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
* [3.13] DOCS: fix error in exec namespace note (gh-119380)Miss Islington (bot)2024-05-221-4/+0
| | | | | | | | | | When updating the new exec note added in gh-119235 as part of the PEP 667 general docs PR, I suggested a workaround that isn't valid. The first half of the note is still reasonable, so just omit the invalid text. (cherry picked from commit 31d61a75c9ae8c1b1bc6447f517122be8adce2ef) Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
* [3.13] gh-110383: Align dict.get(), .fromkeys(), and .setdefault() docs with ↵Miss Islington (bot)2024-05-221-3/+3
| | | | | | | docstrings (GH-119330) (#119370) (cherry picked from commit 0e3c8cda1f04c983994e76aea93600dbb4714832) Co-authored-by: Landon Wood <landon@elkrange.com>
* [3.13] Docs: Add central references to free-threading-related options ↵Miss Islington (bot)2024-05-214-6/+8
| | | | | | | | (GH-119017) (#119367) Docs: Add central references to free-threading-related options (GH-119017) (cherry picked from commit 9fa206aaeccc979a4bd03852ba38c045294a3d6f) Co-authored-by: Brett Simmers <swtaarrs@users.noreply.github.com>