Commit Graph

12232 Commits

Author SHA1 Message Date
Miss Islington (bot) 8e23cd0bbb
[3.11] gh-101100: Fix sphinx warnings in `turtle.rst` (GH-109394) (#109417)
(cherry picked from commit 21e80f4c19)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-09-14 14:41:26 -04:00
Irit Katriel 5681cd1a9d
[3.11] gh-109184: update traceback module doc w.r.t notes (message is no 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 0e76cc359b)
2023-09-12 18:08:38 +01:00
Miss Islington (bot) 0e2d67457b
[3.11] gh-107322: zipapp: Remove the suggestion to remove .dist-info directories (GH-107296) (#109282)
Co-authored-by: wim glenn <hey@wimglenn.com>
2023-09-11 23:53:15 -06:00
Hugo van Kemenade 77356f6f96
[3.11] gh-107924: re-order os.sendfile() flag documentation (#107926) (#109178)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Christoph Anton Mitterer <mail@christoph.anton.mitterer.name>
2023-09-09 03:34:18 -06:00
Miss Islington (bot) d9d64a4a13
[3.11] gh-102823: Document return type of floor division on floats (GH-102824) (#109093)
Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 14:34:30 +00:00
Miss Islington (bot) 297006b6f8
[3.11] gh-71770: Add more details on behavior of configparser's 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>
2023-09-07 14:03:20 +00:00
Miss Islington (bot) 417a7b5b10
[3.11] GH-90915: Document that SystemExit doesn't trigger sys.excepthook (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>
2023-09-07 13:23:08 +00:00
Miss Islington (bot) cccb81d294
[3.11] socket documentation fix - rename triple to 3-tuple (GH-24722) (#109074)
Co-authored-by: Ori Hoch <ori@uumpa.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 13:44:35 +03:00
Miss Islington (bot) f6d70e9a18
[3.11] bpo-38157: Add example about per file output for mock_open. (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>
2023-09-07 12:32:28 +03:00
Miss Islington (bot) 1f115a8822
[3.11] gh-107755: Document the correct default value of slice step (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 9bf350b066)

Co-authored-by: wim glenn <hey@wimglenn.com>
2023-09-07 02:11:53 +02:00
Miss Islington (bot) 5fbd77165b
[3.11] GH-108202: Document ``calendar``'s command-line interface (GH-109020) (#109031)
GH-108202: Document ``calendar``'s command-line interface (GH-109020)
(cherry picked from commit f0f96a9f40)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-09-07 02:11:06 +02:00
Miss Islington (bot) 2ef888d250
[3.11] gh-108857: improve markup in inspect.Signature.replace() docs (GH-108862) (#108970)
gh-108857: improve markup in inspect.Signature.replace() docs (GH-108862)
(cherry picked from commit 6f8411cfd6)

Co-authored-by: nabin2004 <107109731+nabin2004@users.noreply.github.com>
2023-09-06 00:39:09 +00:00
Nikita Sobolev 662d236be2
[3.11] gh-101100: Fix sphinx warnings in `unittest.mock-examples.rst` (GH-108810) (#108812)
(cherry picked from commit 5141b1ebe0)
2023-09-02 13:38:59 +00:00
Miss Islington (bot) fa8b9c147d
[3.11] gh-101100: Fix sphinx warnings in `uuid.rst` (GH-108805) (#108808)
(cherry picked from commit 21da4980f5)

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>
2023-09-02 07:05:07 -06:00
Miss Islington (bot) 0701f8cabd
[3.11] gh-105563: reference DateType in datetime's documentation (GH-105946) (#108790)
gh-105563: reference DateType in datetime's documentation (GH-105946)
(cherry picked from commit 8f9ea43ee8)

Co-authored-by: TATHAGATA ROY <royzen9495@gmail.com>
2023-09-01 20:46:21 +00:00
Gregory P. Smith 6ba1234c1c
[3.11] gh-104372: Drop the GIL around the vfork() call. (#104782) (#104958)
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 d08679212d)
2023-09-01 08:53:06 +00:00
Miss Islington (bot) b4784b0c5f
[3.11] `ast` docs: Fix incorrect link on `keyword` (GH-108728) (#108738)
`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 c1e2f3b2f7)

Co-authored-by: Alex Povel <git@alexpovel.de>
2023-08-31 22:27:27 +00:00
Miss Islington (bot) e93f57208f
[3.11] gh-101100: Fix sphinx warnings in `threading.rst` (GH-108684) (#108708)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-31 11:28:47 +03:00
Miss Islington (bot) d06aaff19d
[3.11] Fix typo in multiprocessing docs (GH-108666) (#108676)
Fix typo in multiprocessing docs (GH-108666)
(cherry picked from commit 38ab0dba80)

Co-authored-by: kato8966 <66937409+kato8966@users.noreply.github.com>
2023-08-30 11:17:23 +00:00
Miss Islington (bot) a2c05a414d
[3.11] Mention Ellipsis pickling in the docs (GH-103660) (#108662)
Mention Ellipsis pickling in the docs (GH-103660)
(cherry picked from commit 14ec0bb7c3)

Co-authored-by: sterliakov <50529348+sterliakov@users.noreply.github.com>
2023-08-29 23:04:42 -07:00
Erlend E. Aasland d79216d48f
[3.11] gh-107801: Improve the accuracy of io.IOBase.seek docs (#108268) (#108656)
(cherry picked from commit 8178a88bd8)

- Add param docstrings
- Link to os.SEEK_* constants
- Mention the return value in the initial paragraph

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-29 19:57:49 +00:00
Alex Waygood b1ed10f413
[3.11] Fix misc doc typos (GH-108592) (#108613)
(cherry picked from commit 88f1c5b)

Co-authored-by: xzmeng <aumo@foxmail.com>
2023-08-29 08:56:14 +00:00
Miss Islington (bot) c19713d4a1
[3.11] Fix typo in typing docs: Remove redundant backtick (GH-108559) (#108561)
Fix typo in typing docs: Remove redundant backtick (GH-108559)
(cherry picked from commit 72b615ab01)

Co-authored-by: nikkie <takuyafjp+develop@gmail.com>
2023-08-28 11:28:19 +00:00
Erlend E. Aasland bd951cd95b
[3.11] gh-107801: Document io.TextIOWrapper.tell (#108265) (#108548)
(cherry picked from commit 38afa4af9b)
2023-08-27 21:22:43 +00:00
Miss Islington (bot) c8e66c47da
[3.11] Fix grammatical error in stringprep documentation (GH-108414) (#108538)
Fix grammatical error in stringprep documentation (GH-108414)

Remove the word "them", which didn't make grammatical sense.

(cherry picked from commit cd0a8aece9)

Co-authored-by: Matthew James Kraai <kraai@ftbfs.org>
Co-authored-by: KRAAI, MATTHEW [VISUS] <mkraai@its.jnj.com>
2023-08-27 14:12:51 +01:00
Miss Islington (bot) 8a275f7c01
[3.11] gh-105052:update timeit function's description (GH-105060) (#108535)
---------
Co-authored-by: Terry Jan Reedy tjreedy@udel.edu
Co-authored-by: R <cherrymelon@foxmail.com>
(cherry picked from commit 7096a2be33)
2023-08-27 03:57:32 -04:00
Miss Islington (bot) a44dcfde18
[3.11] gh-107453: Document errno.{ECANCELED,EOWNERDEAD,ENOTRECOVERABLE,ENOTSUP} (GH-107486) (#108530)
Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-26 23:33:23 -06:00
Miss Islington (bot) af13f0e91b
[3.11] gh-102211: Document `re.{Pattern,Match}`’s existence (GH-102212) (#108491)
Co-authored-by: Philipp A <flying-sheep@web.de>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-08-25 11:28:56 -06:00
Miss Islington (bot) ee61f7db31
[3.11] GH-108202: Document ``calendar`` exceptions (GH-108398) (#108468)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-25 06:06:34 +00:00
Miss Islington (bot) 1ecbe787dd
[3.11] gh-108267: Dataclasses docs: Fix object.__setattr__ typo (GH-108355) (#108357)
gh-108267: Dataclasses docs: Fix object.__setattr__ typo (GH-108355)

Fixed a sentence in dataclasses.rst

Changed "__setattr__" to "object.__setattr__" in a section that was specifically supposed to refer to the __setattr__ method of the object class. Also suppressed the link to the data model docs for __setattr__, since we're talking about a specific __setattr__ implementation, not __setattr__ methods in general.
(cherry picked from commit 79fdacc005)

Co-authored-by: FrozenBob <30644137+FrozenBob@users.noreply.github.com>
2023-08-23 07:20:57 +00:00
Miss Islington (bot) 12cad6155b
[3.11] Docs: Add link to skip to datetime's format codes (GH-108027) (#108330)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-08-22 13:52:51 -06:00
Miss Islington (bot) 9d7f2705b5
[3.11] gh-107700: [Enum] Document that `EnumType` was added in 3.11 (GH-108260) (#108300)
(cherry picked from commit e8ef0bdd8c)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-08-22 20:33:26 +02:00
Miss Islington (bot) d22ac0c605
[3.11] Docs: align the param spec of sqlite3.Connection methods with the implementation (GH-108285) (#108288)
- no parameters of create_aggregate() are positional-only
- all parameters of create_collation() are positional-only
(cherry picked from commit 893215a4e7)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-22 13:28:38 +00:00
Miss Islington (bot) 8e837373ed
[3.11] gh-107845: Fix symlink handling for tarfile.data_filter (GH-107846) (GH-108209)
gh-107845: Fix symlink handling for tarfile.data_filter (GH-107846)

(cherry picked from commit acbd3f9c5c)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
Co-authored-by: Victor Stinner <vstinner@python.org>
Co-authored-by: Lumír 'Frenzy' Balhar <frenzy.madness@gmail.com>
2023-08-22 10:51:58 +02:00
Erlend E. Aasland cc42182c97
[3.11] gh-107801: Improve the accuracy of io.TextIOWrapper.seek docs (#107933) (#108264)
(cherry picked from commit 7f87ebbc3f)

Clearly document the supported seek() operations:

- Rewind to the start of the stream
- Restore a previous stream position (given by tell())
- Fast-forward to the end of the stream
2023-08-22 08:19:56 +00:00
Miss Islington (bot) 4d4871e715
[3.11] gh-108224: Fix asyncio doc inconsistency (GH-108230) (#108232)
(Spawning subprocesses does not require the event loop to run in the main thread -- only signal handling does.)

(cherry picked from commit 1cc391d9e2)

Co-authored-by: temach <tematibr@gmail.com>
2023-08-21 14:21:26 -07:00
Miss Islington (bot) a372274a9b
[3.11] Docs: document 'manager' and '_log' attrs of logging.Logging (GH-108145) (GH-108189)
(cherry picked from commit f904aa4e1f)
Authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-21 11:44:25 +01:00
Erlend E. Aasland e5e87f2306
[3.11] Docs: Fix Sphinx warnings in logging.rst (GH-108139) (#108175)
(cherry picked from commit c735e79afb)

Co-authored-by: Adam Turner <9087854+aa-turner@users.noreply.github.com>
2023-08-20 16:40:57 +00:00
Miss Islington (bot) 5af34d2a4e
[3.11] Docs: Fix Sphinx warnings in sys.rst (GH-108106) (#108166)
Docs: Fix Sphinx warnings in sys.rst (GH-108106)

- Mark up named tuple attributes as attributes
- Remove links for external functions
- io.BufferedIOBase has no 'buffer' attribute;
  remove the link and mark up using :attr:`!buffer`
- (Re)format some tables as bullet lists:
  - sys._emscripten_info
  - sys.hash_info
  - sys.int_info
  - sys.thread_info
- In the paragraphs mentioning 'f_trace_lines' and 'f_trace_opcodes',
  add links to the frame objects reference.

(cherry picked from commit 29fa7afef9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-20 19:22:44 +05:30
Miss Islington (bot) ba6370656f
[3.11] gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (GH-107769) (#108164)
gh-107659: Improve wording of the description of `ctypes.pointer` and `ctypes.POINTER` (GH-107769)
(cherry picked from commit beffb30dc7)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2023-08-20 11:05:24 +00:00
Miss Islington (bot) 4c042a36ce
[3.11] gh-107619: Extend functools LRU cache docs with generators and async functions (GH-107934) (#108162)
gh-107619: Extend functools LRU cache docs with generators and async functions (GH-107934)
(cherry picked from commit 1a713eac47)

Co-authored-by: Hadházy Tamás <85063808+Hels15@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Kumar Aditya <kumaraditya@python.org>
2023-08-20 10:39:43 +00:00
Miss Islington (bot) 5d366f28ae
[3.11] gh-107980: fix doc role for asyncio.timeouts (GH-108126) (#108153)
gh-107980: fix doc role for asyncio.timeouts (GH-108126)
(cherry picked from commit a47c13cae5)

Co-authored-by: Tin Tvrtković <tinchester@gmail.com>
2023-08-20 11:12:15 +01:00
Miss Islington (bot) cdb5e9f76f
[3.11] Fix misspellings in sysconfig docs (GH-108156) (#108158)
Fix misspellings in sysconfig docs (GH-108156)
(cherry picked from commit 1dc0c58d2b)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2023-08-20 08:20:57 +00:00
Miss Islington (bot) 49abeb5eb4
[3.11] Docs: Remove links to external C functions and macros in os.rst (GH-108138) (#108144)
(cherry picked from commit c31c61c04e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-19 17:11:29 +00:00
Erlend E. Aasland e0ca3424ad
[3.11] gh-107801: Improve the accuracy of os.lseek docs (#107935) (#108137)
- name the last parameter *whence*, like it is for seek() methods on
  file objects
- add param docstrings
- structure the valid *whence* params

(cherry picked from commit dd4442c8f5)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-19 13:06:36 +00:00
Miss Islington (bot) 0673d4c762
[3.11] Docs: format sys.float_info properly (GH-108107) (#108131)
Docs: format sys.float_info properly (GH-108107)

- Normalise capitalisation and punctuation
- Use attribute markup for named tuple attributes
- Use :c:macro: markup for C macros
- Use a list for the 'rounds' attribute values
- Use list-table, for better .rst readability
- Remove one unneeded sys.float_info.dig link

(cherry picked from commit ca0c6c1f1e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-19 10:13:09 +01:00
Miss Islington (bot) 9a70989a6f
[3.11] Docs: emphasise warning and add accurate markups for sys.unraisablehook (GH-108105) (#108110)
(cherry picked from commit cc58ec9724)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-18 10:25:08 +00:00
Miss Islington (bot) d6555abfa7
[3.11] gh-107801: Improve the docs of the SEEK_* constants (GH-108099) (#108100)
(cherry picked from commit 02079b010c)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-08-17 20:52:43 +00:00
Miss Islington (bot) b389939be9
[3.11] Docs: Fix Sphinx warnings in io.rst (GH-107903) (#108094)
- Mark up parameter and argument names properly
- If possible, link to docs for methods like `seek`, `tell`, `write`, `read`, etc.

(cherry picked from commit 5c76899dad)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-08-17 19:29:10 +00:00
Miss Islington (bot) 1482b99061
[3.11] gh-107801: Document SEEK_HOLE and SEEK_DATA (GH-107936) (#108087)
(cherry picked from commit 8a19f225b9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Antoine Pitrou <antoine@python.org>
2023-08-17 14:22:39 +00:00