Commit Graph

12461 Commits

Author SHA1 Message Date
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
Adam Turner b3f7ddd040
[3.11] gh-102215: importlib documentation cleanups (#108056)
(cherry picked from commit 4cd95dce0b)

Co-authored-by: Sam Morris <sam@robots.org.uk>
2023-08-17 09:57:48 -04:00
Miss Islington (bot) e2420c5cae
[3.11] gh-107877: Update logging levels reference table with usage criteria. (GH-107894) (GH-107921)
gh-107877: Update logging levels reference table with usage criteria. (GH-107894)
(cherry picked from commit cc2cf85d03)
2023-08-13 14:43:14 +01:00
Eric Snow 951320e4d0
[3.11] gh-98154: Clarify Usage of "Reference Count" In the Docs (gh-107753)
PEP 683 (immortal objects) revealed some ways in which the Python documentation has been unnecessarily coupled to the implementation details of reference counts.  In the end users should focus on reference ownership, including taking references and releasing them, rather than on how many reference counts an object has.

This change updates the documentation to reflect that perspective.
2023-08-07 16:17:12 -06:00
Tomas R 880670a34f
[3.11] gh-107442: Document all valid types for ctypes `_as_parameter_` (GH-107443) (#107718)
(cherry picked from commit 6925c578a0)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2023-08-07 16:42:19 +02:00
Miss Islington (bot) 1878419ed8
[3.11] Improve cross-references in `runpy` docs (GH-107673) (#107699)
Improve cross-references in `runpy` docs (GH-107673)

- Add links to `__main__` and `sys.path` where appropriate
- Ensure each paragraph never has more than one link to the same thing, to avoid visual clutter from too many links
(cherry picked from commit 4e242d1ffb)

Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>
2023-08-06 21:20:24 +00:00
Miss Islington (bot) b89feac759
[3.11] gh-107662: Switch 'any' and 'anext' in functions.rst (GH-107663) (#107665)
gh-107662: Switch 'any' and 'anext' in functions.rst (GH-107663)

Order was reversed in index at top, not in body.
(cherry picked from commit 9ebc6ecbc3)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-08-05 18:25:21 +01:00
Miss Islington (bot) 623b0d9c59
[3.11] Clarify `Self` interaction with subclasses (GH-107511) (#107549)
Co-authored-by: Alexandru Mărășteanu <alexei@users.noreply.github.com>
2023-08-01 20:31:22 +00:00
Miss Islington (bot) 3de42bbf8c
[3.11] gh-105578: Add more usage examples to `typing.AnyStr` docs (GH-107045) (#107504)
gh-105578: Add more usage examples to `typing.AnyStr` docs (GH-107045)

``typing.AnyStr`` has different semantics to ``str | bytes``, which often leads to user confusion
(cherry picked from commit f877b32b87)

Co-authored-by: Michael The <michael-the1@users.noreply.github.com>
2023-07-31 15:33:07 +00:00
Alex Waygood 357708eee0
[3.11] gh-107422: Remove outdated `TypedDict` example from typing docs (#107436) (#107438)
gh-107422: Remove outdated `TypedDict` example from typing docs (#107436)

Co-authored-by: Rakesh Sabale <102187286+ghubrakesh@users.noreply.github.com>
2023-07-29 17:21:45 +00:00
Miss Islington (bot) 3c1bcae075
[3.11] gh-101100: Sphinx warnings: pick the low hanging fruits (GH-107386) (GH-107418)
(cherry picked from commit f2d07d3289)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-29 09:17:20 +03:00
Miss Islington (bot) c3432523d1
[3.11] gh-107091: Fix some uses of :const: role (GH-107379) (GH-107385)
It is for references, not for literals.
(cherry picked from commit 0aa58fa7a6)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-28 10:36:19 +00:00
Miss Islington (bot) 8f0dc1878c
[3.11] gh-106996: Rewrite turtle explanation (GH-107244) (#107336)
Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-27 08:12:17 +00:00
Miss Islington (bot) 603c5d50e8
[3.11] gh-107091: Fix some uses of :c:type: role (GH-107138) (GH-107313)
(cherry picked from commit 6d5b6e71c8)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-27 00:00:36 +03:00
Miss Islington (bot) 35aa6b80a6
[3.11] Document that `os.link()` is not available on Emscripten (GH-104822) (GH-107309)
Document that `os.link()` is not available on Emscripten (GH-104822)
(cherry picked from commit 737d1da074)

Co-authored-by: Roman Yurchak <rth.yurchak@gmail.com>
2023-07-26 13:00:13 -07:00
Wei-Hsiang (Matt) Wang 9fa44d7a30
[3.11] GH-97950: Fix old-style index directive in Doc/library/imp.rst (#107246)
Use new-style index directive ('statement') - library/imp
2023-07-26 08:17:44 +03:00
Miss Islington (bot) 5a89248696
[3.11] gh-106939: document ShareableList nul-strip quirk. (GH-107266) (#107270)
gh-106939: document ShareableList nul-strip quirk. (GH-107266)

* gh-106939: document ShareableList nul-strip quirk.
* Mention the `int` size constraint.
(cherry picked from commit 70dc009469)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-07-25 21:18:23 +00:00
Miss Islington (bot) 1bc160947e
[3.11] gh-106996: Add a how-to section to the turtle documentation (GH-107153) (#107234)
Co-authored-by: Daniele Procida <daniele@vurt.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-07-25 12:17:14 +00:00
Erlend E. Aasland b3e600a632
[3.11] gh-106948: Docs: Disable links for C standard library functions, OS utility functions and system calls (#107062) (#107157)
(cherry picked from commit b447e19e72)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-23 23:49:48 +02:00
wulmer c51f766ebb
[3.11] gh-101100: Fix some broken sphinx references (GH-107095). (#107120) 2023-07-23 05:56:09 -06:00
Daniele Procida 6e3a2fb0fe
[3.11] gh-106996: Add the basics of a turtle graphics tutorial (GH-107072) (#107110) 2023-07-23 04:25:23 -06:00
Serhiy Storchaka ec8718dd7c
[3.11] gh-106948: Add standard external names to nitpick_ignore (GH-106949) (#107061)
It includes standard C types, macros and variables like "size_t",
"LONG_MAX" and "errno", and standard environment variables like "PATH"..
(cherry picked from commit f8b7fe2f26)
2023-07-23 11:24:37 +02:00
Miss Islington (bot) 65e40aaed0
[3.11] gh-54738: Add argparse i18n howto (GH-104562) (#107101)
(cherry picked from commit dcd7acb04a)

Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2023-07-23 11:23:51 +02:00
Miss Islington (bot) 9875b177a9
[3.11] gh-107028: tiny textual changes in logging docs and docstrings (GH-107029) (GH-107066)
(cherry picked from commit 5e5a34ac3a)
2023-07-22 22:12:06 +01:00
Miss Islington (bot) 2895dbd0f6
[3.11] gh-83006: Document behavior of `shutil.disk_usage` for non-mounted filesystems on Unix (GH-107031) (#107048)
(cherry picked from commit 6e5f2235f3)

Co-authored-by: Matthieu Caneill <matthieucan@users.noreply.github.com>
2023-07-22 20:25:15 +02:00
Miss Islington (bot) e5d2a19ac5
[3.11] gh-107008: Document the curses module variables LINES and COLS (GH-107011) (GH-107058)
LINES and COLS referred in curses.update_lines_cols() documentations are
the module variables, not the environment variables.
(cherry picked from commit 26e08dfdd7)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-07-22 21:13:38 +03:00
wulmer b71144193b
[3.11] Fix Sphinx warnings in `re` module docs (GH-107044). (#107055)
(cherry picked from commit 149748ea4f)
2023-07-22 17:39:46 +01:00
Miss Islington (bot) c332117b52
gh-106847: Add -X warn_default_encoding in sys.flags Doc (GH-106854)
gh-106847: Add -X warn_default_encoding in sys.flags Doc (GH-106854)
(cherry picked from commit fd84ac0ee0)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-07-23 01:23:31 +09:00
Miss Islington (bot) 755166e864
[3.11] gh-105090: Replace incorrect TLSv1.2 with TLSv1.3 (GH-105404) (#107038)
Co-authored-by: Jocelyn Castellano <admin@malwarefight.gq>
2023-07-22 14:29:54 +00:00
Sebastiaan Zeeff 4f7c23e4df
[3.11] Change non-integral to non-integer in random docs (GH-106975) (#106985) 2023-07-22 02:37:16 -06:00
Serhiy Storchaka b338ac7540
[3.11] gh-106909: Use role :const: for referencing module constants (GH-106910) (GH-106957)
(cherry picked from commit 4b9948617f)
2023-07-21 14:49:57 +03:00
Serhiy Storchaka cc76113cf8
[3.11] gh-106892: Use roles :data: and :const: for referencing module variables (GH-106894) (GH-106955)
(cherry picked from commit d036db728e)
2023-07-21 14:49:21 +03:00
Serhiy Storchaka 6bde1b9f04
[3.11] gh-106919: Use role :c:macro: for referencing the C "constants" (GH-106920) (GH-106952)
(cherry picked from commit fcc816dbff)
2023-07-21 14:48:30 +03:00
Miss Islington (bot) a5c8d240c0
[3.11] Fix typo in tkinter docs (GH-106936) (#106938)
Fix typo in tkinter docs (GH-106936)
(cherry picked from commit 60e83968d5)

Signed-off-by: Makonede <61922615+Makonede@users.noreply.github.com>
Co-authored-by: Makonede <61922615+Makonede@users.noreply.github.com>
2023-07-21 00:12:00 +01:00
Miss Islington (bot) a6313d78f2
[3.11] gh-106882: Note that `asyncio.Server` is only publicly exposed on 3.11+ (GH-106901) (#106903)
gh-106882: Note that `asyncio.Server` is only publicly exposed on 3.11+ (GH-106901)

And later versions of 3.10, 3.9
(cherry picked from commit 1e1f4e91a9)

Co-authored-by: Jack Nelson <jack@jacknelson.xyz>
2023-07-19 21:03:44 +01:00
Miss Islington (bot) 9532f0e6dd
Doc: fix section levels of devmode doc (GH-106801)
Doc: fix section levels of devmode doc (GH-106801)
(cherry picked from commit e58960160f)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2023-07-16 21:27:51 +09:00
Inada Naoki 77104f5511
Doc: devmode: add -Xdev option to example (GH-106253)
(cherry picked from commit 83bd568d2b)

Co-authored-by: Simone Rubino <daemo00@gmail.com>
2023-07-16 11:43:56 +00:00
Alex Waygood 7dead6a33a
[3.11] gh-106745: typing docs: Clarify that removal of PEP-585 aliases is not currently planned (#106748) (#106773) 2023-07-15 11:34:29 +01:00
Terry Jan Reedy 2186212191
[3.11] gh-106446: Fix failed doctest in stdtypes (GH-106447) (#106742)
(cherry picked from commit 89867d2491)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-07-14 04:02:25 -04:00
Miss Islington (bot) eac0616df9
[3.11] [3.12] gh-96747: Mention the PyPI `passlib` package in the `crypt` deprecation doc (GH-106660) (GH-106660) (#106697)
[3.12] gh-96747: Mention the PyPI `passlib` package in the `crypt` deprecation doc (GH-106660) (GH-106660)

* Added mention to passlib package as alternative to the deprecated crypt module.
(cherry picked from commit ec7b05a0be)

Co-authored-by: Yonatan Bitton <bityob@gmail.com>
2023-07-12 14:59:54 -07:00
Miss Islington (bot) 247f0500b8
[3.11] gh-96165: Clarify passing ":memory:" in sqlite3.connect() (GH-106451) (#106648)
cherry picked from commit f520804b03)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-07-11 22:32:08 +02:00
Miss Islington (bot) 6d8662381d
[3.11] gh-96165: Clarify omitting the FROM clause in SQLite queries (GH-106513) (#106646)
(cherry picked from commit fc7ff1af45)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2023-07-11 22:30:52 +02:00
Miss Islington (bot) dd04697337
[3.11] gh-106461: typing: Consolidate docs on `Callable` (GH-106462) (#106575)
gh-106461: typing: Consolidate docs on `Callable` (GH-106462)
(cherry picked from commit ca8b55c7f5)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-07-09 22:22:46 +01:00
Miss Islington (bot) 44c335e47d
[3.11] gh-101880: add link to object.__hash__() in hash() builtin documentation (GH-101883) (#106547)
gh-101880: add link to object.__hash__() in hash() builtin documentation (GH-101883)
(cherry picked from commit ec7180bd1b)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-07-08 14:23:00 +05:30
Miss Islington (bot) 80117dd450
[3.11] Doc: Add missing ref labels to exception groups/notes sections (GH-106465) (#106474)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-07-06 00:05:04 -06:00
Miss Islington (bot) ada22db147
[3.11] Clarify state of CancelledError in doc (GH-106453) (#106456)
Clarify state of CancelledError in doc (GH-106453)

This change makes it explicit that asyncio.CancelledError is not a subclass of Exception.
(cherry picked from commit 12a9813808)

Co-authored-by: Kristján Valur Jónsson <sweskman@gmail.com>
2023-07-05 11:16:56 -07:00
Miss Islington (bot) 23b731a10d
[3.11] GH-104554: Add RTSPS support to `urllib/parse.py` (GH-104605) (#105760)
RTSPS is the permanent scheme defined in
https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
alongside RTSP and RTSPU schemes.

---------

(cherry picked from commit f3266c05b6)

Co-authored-by: zentarim <33746047+zentarim@users.noreply.github.com>
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
2023-07-05 13:02:36 +02:00
Miss Islington (bot) f5e29f4245
[3.11] gh-101100: Docs: Fix references to several numeric dunders (GH-106278) (#106282)
gh-101100: Docs: Fix references to several numeric dunders (GH-106278)
(cherry picked from commit a8ae73965b)

Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-30 15:40:13 +01:00
Miss Islington (bot) b952ebe4be
[3.11] gh-100408: Fix a traceback in multiprocessing example (GH-100409) (GH-106231)
(cherry picked from commit a28d4edb23)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2023-06-29 14:29:22 +03:00
Miss Islington (bot) ce091c96cf
[3.11] gh-101100: Fix reference to `parse_args` in `optparse.rst` (GH-105265) (#106205)
Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
2023-06-28 12:41:18 +00:00
Miss Islington (bot) 0523f6de1f
[3.11] gh-105993: Add possible `None` return type to `asyncio.EventLoop.start_tls` docs (GH-105995) (#106189)
gh-105993: Add possible `None` return type to `asyncio.EventLoop.start_tls` docs (GH-105995)
(cherry picked from commit 6b52a581c1)

Co-authored-by: Sam Bull <git@sambull.org>
2023-06-28 16:36:25 +05:30
Miss Islington (bot) 43c603a60f
[3.11] gh-101100: Fix reference to asynchronous methods (GH-106172) (#106192)
gh-101100: Fix reference to asynchronous methods (GH-106172)
(cherry picked from commit bbf722dcd3)

Co-authored-by: F3eQnxN3RriK <drsuaimqjgar@gmail.com>
2023-06-28 16:35:51 +05:30
Miss Islington (bot) 2cce465416
[3.11] Refer to `TimeoutError` instead of `asyncio.TimeoutError` in `asyncio-task.rst` (GH-106136) (#106180)
Co-authored-by: lightdrk <108566237+lightdrk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-27 23:38:26 -06:00
Miss Islington (bot) 86dbf1d112
[3.11] gh-92788: Add docs for `ast.Module`, `ast.Expression`, and others (GH-101055) (#106138)
gh-92788: Add docs for `ast.Module`, `ast.Expression`, and others (GH-101055)
(cherry picked from commit 33608fd67d)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-06-27 13:44:32 +00:00
Miss Islington (bot) 956b66b61b
[3.11] GH-105774: Clarify operation of normalize() (GH-106093) (GH-106129) 2023-06-26 23:32:43 -05:00
Miss Islington (bot) 97cf0291f5
[3.11] gh-106107: document correct error that's raised when a mutable default value for a field is detected (gh-106109) (gh-106116)
gh-106107: document correct error that's raised when a mutable default value for a field is detected (gh-106109)
(cherry picked from commit 512f299e55)

Co-authored-by: Roderich Schupp <roderich.schupp@gmail.com>
2023-06-26 14:12:40 -04:00
Miss Islington (bot) 8c792749cb
[3.11] Improve typing docs on the type of class objects (GH-106081) (#106097)
Improve typing docs on the type of class objects (GH-106081)
(cherry picked from commit 3eeb8c8906)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-26 09:43:41 +01:00
Miss Islington (bot) 1bbf60dc31
[3.11] Docs: add links to 'callable' term in sqlite3 docs (GH-106072) (#106074)
(cherry picked from commit bef1c8761e)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2023-06-25 10:16:30 +02:00
Miss Islington (bot) 05d06e583b
[3.11] Typing docs: fix typo in annotating tuples comment (GH-106048) (#106050)
Typing docs: fix typo in annotating tuples comment (GH-106048)
(cherry picked from commit 8ef0ee4ebc)

Co-authored-by: Eamon Tracey <66919574+EamonTracey@users.noreply.github.com>
2023-06-23 21:35:16 +01:00
Miss Islington (bot) 15f4bba7a7
[3.11] Typing docs: improve the guidance on annotating tuples (GH-106021) (#106029)
Typing docs: improve the guidance on annotating tuples (GH-106021)
(cherry picked from commit 968435ddb1)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-23 15:53:14 +01:00
Miss Islington (bot) 6d232ba2ec
[3.11] stdtypes.rst: remove a period (GH-105959) (#105969)
stdtypes.rst: remove a period (GH-105959)
(cherry picked from commit c5a722be5f)

Co-authored-by: Mathieu Dupuy <deronnax@gmail.com>
2023-06-21 15:40:46 +01:00
Alex Waygood 8bb16f6656
[3.11] typing docs: Improve the intro to each section (#105901) (#105903)
typing docs: Improve the intro to each section (#105901)
2023-06-19 01:17:06 +01:00
Carl Meyer 7c877b58e0
[3.11] bpo-44530: Document the change in MAKE_FUNCTION behavior (GH-93189) (#105842)
* bpo-44530: Document the change in MAKE_FUNCTION behavior

Fixes dis module documentation for MAKE_FUNCTION due to 2f180ce2cb (bpo-44530, released as part of 3.11) removes the qualified name at TOS.
(cherry picked from commit 486b52a315)

Co-authored-by: Alex Doe <alexdoesh@gmail.com>
2023-06-16 12:17:58 -05:00
Miss Islington (bot) aa927f9f96
[3.11] tarfile: Fix positional-only syntax in docs (GH-105770) (#105772)
The syntax used in the current docs (a / before any args) is invalid.

I think the right approach is for the arguments to arbitrary
filter functions to be treated as positional-only, meaning that users
can supply filter functions with any names for the argument. tarfile.py
only calls the filter function with positional arguments.
(cherry picked from commit 5cdd5ba49d)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-06-15 22:43:30 -07:00
Alex Waygood 6be46c37c6
[3.11] More reorganisation of the typing docs (#105787) (#105816) 2023-06-15 10:05:50 +01:00
Alex Waygood c197bd8826
[3.11] Improve docs for `typing.dataclass_transform` (#105792) (#105815)
(cherry-picked from commit 006a453205)
2023-06-15 09:56:14 +01:00
Alex Waygood ab0546881f
[3.11] Typing docs: move the deprecated stuff below the non-deprecated stuff (#105781) (#105785) 2023-06-14 15:40:02 +01:00
Alex Waygood f207b346d4
[3.11] Remove stray reference to PEP-695 in the typing docs (#105655) 2023-06-11 17:10:49 +01:00
Miss Islington (bot) aaa8a493ec
[3.11] Cleanup and clarify our hashlib docs. (GH-105624) (#105633)
Cleanup and clarify our hashlib docs. (GH-105624)

Clarify and improve our hashlib docs. Now with 50% less mess!
(cherry picked from commit 0d1d6ab966)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-06-10 11:50:27 -07:00
Alex Waygood 6cb1308005
[3.11] Miscellaneous improvements to the typing docs (#105529) (#105568)
Miscellaneous improvements to the typing docs (#105529)

Mostly, these are changes so that we use shorter sentences and shorter paragraphs. In particular, I've tried to make the first sentence introducing each object in the typing API short and declarative.
2023-06-09 22:41:22 +01:00
Miss Islington (bot) c28887d059
[3.11] Clarify the supported cases in the tokenize module (GH-105569) (#105574)
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2023-06-09 16:00:53 +00:00
Alex Waygood faf15fda28
[3.11] Fix two errors in the typing docs (#105559) 2023-06-09 14:14:47 +01:00
Miss Islington (bot) af80db063f
[3.11] Further improve docs for `typing.Annotated` (GH-105498) (#105504)
* Further improve docs for `typing.Annotated` (GH-105498)
(cherry picked from commit d213c2990f)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-08 15:06:39 +00:00
Alex Waygood 02c5513b30
[3.11] [typing docs] Don't describe `Sized` and `Hashable` as deprecated in the 3.11 docs (#105496) 2023-06-08 13:09:52 +01:00
Alex Waygood ccc971714e
[3.11] typing: Improve documentation of generic classes and aliases (#105369) (#105454) 2023-06-07 21:27:15 +00:00
Miss Islington (bot) 40d1d28b07
[3.11] gh-90015: Document that PEP-604 unions do not support forward references (GH-105366) (#105461)
gh-90015: Document that PEP-604 unions do not support forward references (GH-105366)
(cherry picked from commit fbdee000de)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 19:11:33 +01:00
Jelle Zijlstra 34f23904e1
[3.11] Improve docs for `typing.TypeAlias` (GH-105372). (#105447)
(cherry picked from commit c5ec51ec8f)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 07:14:36 -07:00
Jelle Zijlstra d0af5272a7
[3.11] gh-97797: Improve documentation for typing.Annotated (GH-105365). (#105449)
(cherry picked from commit e26d296984)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-07 07:14:01 -07:00
Alex Waygood 0d2ed56f6c
[3.11] Improve code examples in `typing.rst` (#105346) (#105427) 2023-06-07 06:41:35 -07:00
Miss Islington (bot) 039f30380b
[3.11] typing docs: Make the PEPs list an expandable section, hidden by default (GH-105353) (#105421)
typing docs: Make the PEPs list an expandable section, hidden by default (GH-105353)
(cherry picked from commit d7645124f5)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-06-07 07:50:31 +01:00
Miss Islington (bot) 5e4c46f029
[3.11] GH-95088: Clarify rules for parsing an item key for format strings (GH-103779) (#105418)
GH-95088: Clarify rules for parsing an item key for format strings (GH-103779)
(cherry picked from commit 3e7316d7e8)

Co-authored-by: achhina <amanschhina@gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-06-06 20:56:03 -07:00
Miss Islington (bot) 2456136360
[3.11] `typing.NewType` docs: the future performance improvements are now in the past (GH-105354) (#105415)
`typing.NewType` docs: the future performance improvements are now in the past (GH-105354)
(cherry picked from commit 5f65ff0370)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-06-06 20:55:46 -07:00
Miss Islington (bot) faae548e0e
[3.11] gh-89412: Add missing attributes (added in 3.10) to traceback module docs (GH-105046) (#105328)
(cherry picked from commit a4f72fa39a)

Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-06-05 19:02:23 +02:00
Miss Islington (bot) 86eab0807f
[3.11] gh-104882: Docs: fix description of relationship between `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 5a5ed7a3e6)

Co-authored-by: Joe Geisbauer <joegeisbauer@gmail.com>
2023-06-04 17:09:13 +01:00
Victor Stinner 5de6ca59fb
[3.11] gh-105096: Reformat wave documentation (#105136) (#105138) (#105155)
[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 85e5d03163)
(cherry picked from commit 01b42f9559)
2023-05-31 16:40:25 +00:00
Miss Islington (bot) c39500db52
[3.11] GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044) (#105067)
GH-89455: Add missing attributes (added in 3.11) to traceback module docs (GH-105044)
(cherry picked from commit 39f6a0489f)

Co-authored-by: Jakub Kuczys <me@jacken.men>
2023-05-29 20:37:49 +01:00
Jelle Zijlstra d34e58a1d5
[3.11] gh-103921: Improve typing documentation (GH-104642) (#105007)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-27 16:30:41 -07:00
Miss Islington (bot) a632697225
[3.11] gh-104984: remove kwargs and starargs from Call & ClassDef (GH-104986) (#104988)
gh-104984: remove kwargs and starargs from Call & ClassDef (GH-104986)

These fields are removed in 025e9ebd0a
(cherry picked from commit 61c1d6760f)

Co-authored-by: Shaygan Hooshyari <sh.hooshyari@gmail.com>
2023-05-26 18:14:03 +01:00
Miss Islington (bot) 3b3f2e107b
[3.11] gh-104874: Document NewType.__supertype__ (GH-104875) (#104907)
gh-104874: Document NewType.__supertype__ (GH-104875)
(cherry picked from commit 41768a2bd3)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-25 00:35:58 +01:00
Prince Roshan 2ade563abc
[3.11] gh-103606: Improve error message from logging.config.FileConfig (GH-103628) (#104687)
* gh-103606: Improve error message from logging.config.FileConfig (GH-103628)

(cherry picked from commit 152227b569)

plus backport the followup exception change fix to that in #104701
2023-05-21 12:17:18 -07:00
Jelle Zijlstra abb32de8c4
[3.11] typing docs: Move some classes out of the "Generics" section (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 ab71acd67b)

---------

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-05-21 14:31:26 +01:00
Miss Islington (bot) dc0c41b2e5
[3.11] Corrected identifier (GH-104713) (#104714)
Corrected identifier (GH-104713)
(cherry picked from commit 60993ba8b4)

Co-authored-by: William Sawyer <wmsawyer2609@gmail.com>
2023-05-21 02:06:17 -04:00
Miss Islington (bot) d45c1df83e
[3.11] gh-49174: document that the effect of calling gc.collect() during a 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 30488fa22a)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-05-20 20:12:52 +00:00
han-solo 89bd454cd9
[3.11] gh-104679 Fixed syntax highlighting in turtle docs (GH-104682). (#104695)
(cherry picked from commit 2c97878bb8)
2023-05-20 12:36:43 -04:00
Miss Islington (bot) e5b6f38df4
[3.11] docs: fix wrong indentation causing rendering error in dis page (GH-104661) (#104670)
docs: fix wrong indentation causing rendering error in dis page (GH-104661)
(cherry picked from commit 3bc94e678f)

Co-authored-by: Nyakku Shigure <sigure.qaq@gmail.com>
2023-05-19 23:25:43 +03:00
Hugo van Kemenade cd13f73afd
[3.11] gh-104659: Consolidate python examples in enum documentation (#104665) (#104666)
gh-104659: Consolidate python examples in enum documentation (#104665)

(cherry picked from commit 3ac856e697)

Co-authored-by: Thomas Hisch <t.hisch@gmail.com>
2023-05-19 23:12:57 +03:00
Miss Islington (bot) 610cc0ab1b
[3.11] gh-102153: Start stripping C0 control and space chars in `urlsplit` (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 2f630e1ce1)

Co-authored-by: Illia Volochii <illia.volochii@gmail.com>
Co-authored-by: Gregory P. Smith [Google] <greg@krypto.org>
2023-05-17 21:41:25 +00:00
Miss Islington (bot) 9cac6c414f
[3.11] gh-104539: Fix indentation error in logging.config.rst (GH-104545) (#104546)
gh-104539: Fix indentation error in logging.config.rst (GH-104545)

Fix indentation error in logging.config.rst
(cherry picked from commit 0bb61dd5b0)

Co-authored-by: Jesper Noordsij <45041769+jnoordsij@users.noreply.github.com>
2023-05-16 13:53:18 +01:00
Miss Islington (bot) a712c5f42d
[3.11] gh-67056: document that registering/unregistering an atexit func from within an atexit func is undefined (GH-104473) (#104500) 2023-05-15 10:15:07 +01:00
Miss Islington (bot) 8e79414efc
[3.11] gh-104337: Clarify random.gammavariate doc entry (GH-104410) (#104481)
(cherry picked from commit 88c5c58670)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-05-14 16:25:25 -04:00
Miss Islington (bot) f5f99756e1
[3.11] Minor improvements to typing docs (GH-104465) (#104475)
Minor improvements to typing docs (GH-104465)
(cherry picked from commit 2f7b5e458e)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-14 13:00:57 +01:00
Miss Islington (bot) e794d469e3
[3.11] Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430) (#104447)
Add a mention of PYTHONBREAKPOINT to breakpoint() docs (GH-104430)
(cherry picked from commit 1be80ed107)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2023-05-13 07:16:28 +00:00
Erlend E. Aasland 7055088500
[3.11] gh-101117: Improve accuracy of sqlite3.Cursor.rowcount docs (#104287) (#104381)
The SQLite C API sqlite3_changes() can only be relied upon when the
current active statement has been run to completion.
2023-05-11 11:09:46 +02:00
Miss Islington (bot) a8e902d2c2
[3.11] gh-104010: Separate and improve docs for `typing.get_origin` and `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 a7a2dbbf72)

Co-authored-by: chgnrdv <52372310+chgnrdv@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-10 07:49:49 -07:00
Miss Islington (bot) 03abac239c
[3.11] gh-103960: Dark mode: invert image brightness (GH-103983) (#104358)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-05-10 14:19:38 +00:00
Miss Islington (bot) 2fa14d47af
[3.11] gh-48241: Clarify URL needs to be encoded when provided to urlopen and Request (GH-103855) (#103891)
(cherry picked from commit 44010d0f12)

Co-authored-by: Michael Blahay <mblahay@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-05-10 00:22:06 +02:00
Miss Islington (bot) fffdbf4831
[3.11] gh-102327: Extend docs for "url" and "headers" parameters to 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 7ba6288feb)

Co-authored-by: David Foster <david@dafoster.net>
Co-authored-by: Éric <earaujo@caravan.coop>
2023-05-09 20:00:58 +00:00
Shantanu 15624b445e
[3.11] gh-102500: collections.abc.Buffer doesn't exist in 3.11 (#104317) 2023-05-09 10:27:15 +01:00
Miss Islington (bot) 8a6ff59e09
[3.11] GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172) (#104295)
GH-104145: Use fully-qualified cross reference types for the bisect module (GH-104172)
(cherry picked from commit 76eef552f3)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-08 17:41:20 +01:00
Alex Waygood 499b79d0b9
[3.11] gh-102500: Remove mention of bytes shorthand (#104281) (#104288)
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-08 15:23:10 +01:00
Miss Islington (bot) efcd4bcb87
[3.11] gh-104254: Document the optional keyword-only "context" argument to 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 4ee2068c34)

Co-authored-by: Itamar Ostricher <itamarost@gmail.com>
2023-05-07 09:52:23 +05:30
Miss Islington (bot) 4b11af058e
[3.11] GH-97950: Use new-style index directive ('builtin') (GH-104164) (#104221)
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 f5088006ca)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-06 07:14:37 +03:00
Miss Islington (bot) bb4369e15f
[3.11] gh-104112: link from cached_property docs to method-caching FAQ (GH-104113) (#104182)
gh-104112: link from cached_property docs to method-caching FAQ (GH-104113)
(cherry picked from commit fa86a77589)

Co-authored-by: Carl Meyer <carl@oddbird.net>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-04 17:10:34 -06:00
Miss Islington (bot) 6a970ae666
[3.11] GH-97950: Use new-style index directive ('statement') (GH-104162) (#104163)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 13:57:14 +03:00
Miss Islington (bot) c463796ba7
[3.11] GH-97950: Use new-style index directive ('object') (GH-104158) (#104159)
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 6ab463684b)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 13:14:16 +03:00
Miss Islington (bot) 693ef48df1
[3.11] GH-97950: Use new-style index directive ('operator') (GH-104156) (#104157)
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2023-05-04 12:27:04 +03:00
Adam Turner 00563694bb
[3.11] GH-97950: Use new-style index directive ('module') (GH-103996) (#104154) 2023-05-04 11:39:15 +03:00
Miss Islington (bot) 365e0772c9
[3.11] gh-101100: Fix Sphinx warnings in `curses` and `curses.ascii` modules (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 23:20:50 -06:00
Shantanu f9231a09be
[3.11] gh-65022: Fix description of tuple return value in copyreg (GH-103892) (#104098)
(cherry picked from commit 587f2f0180)
2023-05-02 11:18:41 -07:00
Rafael Fontenelle 5e76305236
[3.11] GH-103484: Fix redirected permanently URLs (GH-104001) (#104088)
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 14:50:16 +03:00
Miss Islington (bot) 3e7e50e656
[3.11] Improve assert_type phrasing (GH-104081) (#104084)
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 82ba6ce303)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-02 08:44:16 +01:00
Miss Islington (bot) d8055b889c
[3.11] Adjust expression from `==` to `!=` in alignment with the meaning of the paragraph. (GH-104021) (GH-104031)
(cherry picked from commit 93107aa2a4)
2023-05-01 06:58:33 +01:00
Shantanu 86ef1ce121
[3.11] Fix description of MAKE_CELL (#103986)
Backport of part of #103923
2023-04-29 06:12:46 -07:00
Miss Islington (bot) 9fbb614c4e
[3.11] gh-99032: datetime docs: Encoding is no longer relevant (GH-93365) (#103788)
This removes a section of the `strftime` and `strptime` documentation that refers to a bygone era when `strftime` would return an encoded byte string.

---------

(cherry picked from commit 2aa22f72fb)

Co-authored-by: William Andrea <william.j.andrea@gmail.com>
Co-authored-by: Paul Ganssle <1377457+pganssle@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-04-28 20:09:55 -07:00
Petr Viktorin 241f2e54a6
[3.11] gh-102950: Implement PEP 706 – Filter for tarfile.extractall (GH-102953) (GH-103832)
See [Backporting & Forward Compatibility in PEP 706](https://peps.python.org/pep-0706/#backporting-forward-compatibility).

- Backport b52ad18a76
- Backport c8c3956d90
- Remove the DeprecationWarning
- Adjust docs
- Remove new `__all__` entries
2023-04-28 17:41:09 +02:00
Erlend E. Aasland b3faf8ceec
[3.11] gh-100021: Document that sqlite3's executemany() discards resulting rows (#103939) (#103966) 2023-04-28 08:05:14 +00:00
Erlend E. Aasland 294398c102
[3.11] Docs: fix dunders with too many underscores (#103955) (#103957) 2023-04-27 22:27:59 +00:00
Adam Turner dbc44fab7a
[3.11] GH-103903: Test the minimum Sphinx version in CI (#103904) (#103948)
[3.11] GH-103903: Test the minimum Sphinx version in CI (GH-103904).

(cherry picked from commit 44b5c21f41)
2023-04-27 20:55:09 +00:00
Alex Waygood d20758c4ef
[3.11] gh-51574: Document behaviour of `mkdtemp` on 3.11 and lower (#103844) 2023-04-27 07:56:55 -07:00
Shantanu c0b538b02f
[3.11] gh-101786: Clarify docs that asyncio.Server.sockets is a socket-like TransportSocket (GH-103877) (#103890)
Clarify that asyncio.Server.sockets is a socket-like TransportSocket
(cherry picked from commit 1c0a9c5a1c)

Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2023-04-26 15:03:34 -06:00
Miss Islington (bot) 410c2ce956
[3.11] gh-94300: Update datetime.strptime documentation (GH-95318) (#103785)
gh-94300: Update datetime.strptime documentation (GH-95318)

The new wording better reflects the cases where `datetime.strptime` differs from` time.strptime`.

---------

(cherry picked from commit 5b404d6cad)

Co-authored-by: Howie Zhao <howiezhaohr@hotmail.com>
Co-authored-by: Paul Ganssle <git@m.ganssle.io>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Alexander Belopolsky <abalkin@users.noreply.github.com>
2023-04-26 14:55:39 -06:00
Miss Islington (bot) bce93c2d83
[3.11] gh-101879: docs - italicize argument in smtplib.SMPT() description (GH-101886) (#103888)
gh-101879: docs - italicize argument in smtplib.SMPT() description (GH-101886)
(cherry picked from commit 28a05f4cc2)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-04-26 16:37:32 -04:00
Miss Islington (bot) d9aafe2499
[3.11] gh-103721: Improve cross-references for generic-alias docs (GH-103838) (#103840)
Cc. @adriangb

The "stub documentation" in `types.rst` does already link to the
in-depth docs in `stdtypes.rst`, but the link isn't obvious for new
users. It deserves to be made more prominent.

- Issue: https://github.com/python/cpython/issues/103721
(cherry picked from commit cef542ca57)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-04-25 22:58:25 +00:00
Miss Islington (bot) 026c3e9cc4
[3.11] gh-91687: modernize dataclass example typing (GH-103773) (#103774)
modernize dataclass example typing `list` rather than `List` and comment
as to that line being the alluded too error.
(cherry picked from commit 7ef614c1ad)

Co-authored-by: Allan Lago <35788148+alago1@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-04-25 18:16:05 +02:00
Miss Islington (bot) 05a25867ae
[3.11] gh-87452: Improve the Popen.returncode docs (#103771)
Clarifies that it remains None until a method checking the child process
status has been called and noticed it has terminated.
(cherry picked from commit 68f5836582)

Co-authored-by: Joshua Herman <30265+zitterbewegung@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2023-04-25 18:15:48 +02:00
Miss Islington (bot) 03f8d8f0d8
[3.11] ctypes docs: fix missing `not` in variadic functions section (GH-102611) (#103425)
(cherry picked from commit 975d220bbe)

Co-authored-by: mara004 <geisserml@gmail.com>
2023-04-25 16:21:39 +05:30
Łukasz Langa 56d50dd9fb
[3.11] gh-103810: Fix broken references in dataclasses (GH-103811) (#103813)
(cherry picked from commit 0f23eda4b9)

Co-authored-by: Olga Matoula <olgamatoula@gmail.com>
2023-04-24 23:29:03 +00:00
Hugo van Kemenade 9f4364355e
[3.11] gh-101100: Fix Sphinx warnings in `argparse` module (#103289) (#103803)
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-24 22:15:04 +00:00
Miss Islington (bot) 6f92d3f01a
[3.11] gh-103765: Fix 'Warning: py:class reference target not found: ModuleSpec' (GH-103769) (#103799)
(cherry picked from commit d2745fe850)

Co-authored-by: Jaime Alonso Lorenzo <jaimealonsolorenzo@gmail.com>
2023-04-24 15:57:21 -06:00
Kumar Aditya 16dabf9e56
[3.11] GH-78530: clarify docs for generators yielding tasks in `asyncio.wait` and `asyncio.as_completed` (#103748) 2023-04-24 14:33:12 +05:30
Rafael Fontenelle 8642fdce8c
[3.11] GH-103484: Fix broken links reported by linkcheck (GH-103608) (#103683)
Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Fix broken links reported by linkcheck (#103608)
2023-04-23 23:26:15 +03:00
Miss Islington (bot) a43dbe13e2
[3.11] gh-68654: Clarify subdirectories used by pkgutil.extend_path (GH-103701)
gh-68654: Clarify subdirectories used by pkgutil.extend_path (GH-103701)

Clarify sub directories used by pkgutil.extend_path in the docs and the docstring
(cherry picked from commit 7bf94568a9)

Co-authored-by: Randy <69558016+san-juan1667@users.noreply.github.com>
2023-04-23 02:57:10 -06:00
Miss Islington (bot) 050b6b34d0
[3.11] Revert "Avoid error lexing multiprocessing docs code block on Pygments 2.15.0" (GH-103616) (#103695)
Revert "Avoid error lexing multiprocessing docs code block on Pygments 2.15.0" (GH-103616)

This reverts commit ace51dcdb7.
(cherry picked from commit 8cb2b0f953)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-04-22 16:13:22 -06:00
Miss Islington (bot) 7f6710bab6
[3.11] GH-103475: cache() and lru_cache() do not have a "call once" guarantee (GH-103669) (#103682)
GH-103475: cache() and lru_cache() do not have a "call once" guarantee (GH-103669)
(cherry picked from commit e5eaac6064)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-04-22 09:54:58 -06:00
Miss Islington (bot) 2b5dbd1f23
Doc: Fix broken link to emscripten networking website (GH-99531)
There was an extra `>` in the url.
(cherry picked from commit ed206e39f0)

Co-authored-by: Alexander Ryabov <73594+haron@users.noreply.github.com>
2023-04-19 07:37:14 -07:00
Miss Islington (bot) 5a81a24c8b
gh-103582: Remove last references to `argparse.REMAINDER` from docs (GH-103586)
(cherry picked from commit f4d087964e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-04-18 22:14:53 -07:00
Miss Islington (bot) 804a973d8e
gh-103365: [Enum] STRICT boundary corrections (GH-103494)
STRICT boundary:

- fix bitwise operations
- make default for Flag
(cherry picked from commit 2194071540)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-13 08:55:53 -07:00
Miss Islington (bot) e643412ef4
gh-103417: use time.monotonic in the example for sched.scheduler (GH-103418)
(cherry picked from commit f2b7ecb778)

Co-authored-by: Nick Burns <nburns@users.noreply.github.com>
2023-04-12 02:09:08 -07:00
Miss Islington (bot) b5fe28dace
gh-103237: Polish pdb docs (GH-103238)
(cherry picked from commit 449bf2a76b)

Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
2023-04-11 23:26:33 -07:00
Miss Islington (bot) e715da6db1
gh-87864: Use correct function definition syntax in the docs (GH-103312)
(cherry picked from commit 50b4b15984)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-04-11 07:19:33 -07:00
Miss Islington (bot) 07a2851edb
gh-103373: `__mro_entries__` docs: improve cross references (GH-103398)
(cherry picked from commit e071f00aae)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-11 03:34:46 -07:00
Miss Islington (bot) 4a05392adb
Doc: Avoid error lexing multiprocessing docs code block on Pygments 2.15.0 (GH-103421)
(cherry picked from commit 75b6ab80da)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-10 21:07:21 -07:00
Miss Islington (bot) b80e4c89d8
[3.11] gh-103059: Clarify gc.freeze documentation (GH-103058) (#103416)
gh-103059: Clarify gc.freeze documentation (GH-103058)
(cherry picked from commit 8b1b17134e)

Co-authored-by: raylu <lurayl@gmail.com>
2023-04-10 11:17:48 -06:00
Miss Islington (bot) 7b03d0f7c5
gh-100574: add examples/links to the `strptime`/`strftime` docs (GH-100575)
(cherry picked from commit 3310b94d3d)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2023-04-08 01:56:31 -07:00
Miss Islington (bot) bbe04d9d1c
gh-103266: Fix a typo in example code for bisect() function (GH-103267)
(cherry picked from commit f0424ba4b6)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-04-06 17:45:07 -07:00
Miss Islington (bot) 09fb27fa51
gh-102899: Fix doc link for getting filesystem error handler (GH-102901)
(cherry picked from commit fdd0fff277)

Co-authored-by: Olivier Gayot <olivier.gayot@sigexec.com>
2023-04-05 08:03:47 -07:00
Miss Islington (bot) 9357fc9b89
gh-81762: Clarify and simplify description of print's flush param (GH-103264)
(cherry picked from commit c396b6ddf3)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-05 04:49:08 -07:00
Miss Islington (bot) 6258c3cd53
Improve some grammar in the socket docs (GH-103254)
(cherry picked from commit bceb9e00ad)

Co-authored-by: Tim Burke <tim.burke@gmail.com>
2023-04-04 15:54:37 -07:00
Miss Islington (bot) cf72cc25f6
gh-98298, gh-74730: [Enum] update docs (GH-103163)
fix FlagBoundary statements
add warning about reloading modules and enum identity
(cherry picked from commit 5ffc1e5a21)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2023-04-03 15:27:33 -07:00
Miss Islington (bot) 823622212e
gh-102994: Profile docs has typo in example (GH-103074)
(cherry picked from commit 55decb72c4)

Co-authored-by: Nouran Ali <nouranalimohammed@gmail.com>
2023-04-02 15:52:11 -07:00
Miss Islington (bot) 0854bdf15f
gh-103109: Document ignore_warnings() test support helper (GH-103110)
(cherry picked from commit 32937d6aa4)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-04-02 15:42:43 -07:00
Miss Islington (bot) 4664a7cf68
Quote literal tokens in standard format specifier grammar (GH-102902)
Reported by Damian Dureck: https://mail.python.org/archives/list/docs@python.org/thread/UZTWBJIXC3MBKTHXVTIBPGDPKBNWZ5LN/
(cherry picked from commit f6405a4662)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2023-03-31 05:52:52 -07:00
Miss Islington (bot) 41e3ea1396
Minor docs improvements fix for `codeop` (GH-103123)
(cherry picked from commit c1e71ce56f)

Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
2023-03-30 15:58:54 -07:00
Miss Islington (bot) 1b40618247
gh-103099: Link mypy docs from typing.rst (GH-103100)
(cherry picked from commit fda95aa194)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-03-30 01:39:49 -07:00
Miss Islington (bot) e1094c6e6a
Update pdb docs for arguments (GH-102965)
(cherry picked from commit 027223db96)

Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
2023-03-25 14:42:28 -07:00
Miss Islington (bot) aae91fa63c
[3.11] gh-103025: fix a ctypes doc typo (GH-103026) (#103029)
* gh-103025: fix two ctypes doc issues  (GH-103026)
(cherry picked from commit 0708437ad0)

Co-authored-by: Peter Jiping Xie <peter.jp.xie@gmail.com>
2023-03-25 10:00:44 +00:00
Hugo van Kemenade 85c686a1a5
[3.11] gh-101100: Document PyObject_ClearWeakRefs, gzip's name, and asyncio.iscoroutine (#103001) 2023-03-25 09:43:52 +02:00
Miss Islington (bot) c834a4c713
gh-102873: logging.LogRecord docs: improve description of `msg` parameter (GH-102875)
(cherry picked from commit f2e5a6ee62)

Co-authored-by: Amin Alaee <mohammadamin.alaee@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-24 08:08:48 -07:00
Miss Islington (bot) e075631f67
[3.11] gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers (GH-96932) (#102918)
gh-96931: Fix incorrect results in ssl.SSLSocket.shared_ciphers (GH-96932)
(cherry picked from commit af9c34f6ef)

Co-authored-by: Benjamin Fogle <benfogle@gmail.com>
2023-03-24 13:33:24 +01:00
Miss Islington (bot) 60b2b58f87
[3.11] Minor readability improvement to the factor() recipe (GH-102971) (GH-102972) 2023-03-23 14:56:35 -05:00
Miss Islington (bot) 202e16ea05
gh-98239: Document that `inspect.getsource()` can raise `TypeError` (GH-101689)
(cherry picked from commit b6132085ca)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-03-23 12:42:54 -07:00
Miss Islington (bot) e2924c0ee5
gh-102936: typing: document performance pitfalls of protocols decorated with `@runtime_checkable` (GH-102937)
(cherry picked from commit 58d2b30c01)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 11:27:28 -07:00
Miss Islington (bot) 84ae50c914
gh-102810 Improve the sphinx docs for `asyncio.Timeout` (GH-102934)
(cherry picked from commit f13fdacadf)

Co-authored-by: JosephSBoyle <48555120+JosephSBoyle@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-23 09:52:43 -07:00
Miss Islington (bot) a9ece4a839
gh-102780: Fix uncancel() call in asyncio timeouts (GH-102815)
Also use `raise TimeOut from <CancelledError instance>` so that the CancelledError is set
in the `__cause__` field rather than in the `__context__` field.

(cherry picked from commit 04adf2df39)

Co-authored-by: Kristján Valur Jónsson <sweskman@gmail.com>
Co-authored-by: Guido van Rossum <gvanrossum@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-03-22 11:23:47 -07:00
Miss Islington (bot) f1b96737a4
gh-102921: [doc] Clarify `exc` argument name in `BaseExceptionGroup` is plural (GH-102922)
(cherry picked from commit 9b19d3936d)

Co-authored-by: Kevin Kirsche <Kev.Kirsche+GitHub@gmail.com>
2023-03-22 11:21:59 -07:00
Miss Islington (bot) 592c34469b
Docs: improve accuracy of sqlite3.Connection.interrupt() (GH-102904)
(cherry picked from commit 7b2d53dacc)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 05:00:25 -07:00
Miss Islington (bot) 9a1453b651
Docs: improve the accuracy of the sqlite3.connect() timeout param (GH-102900)
(cherry picked from commit c24f1f1e87)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-22 04:49:46 -07:00
Miss Islington (bot) 44782d3d34
Docs: improve accuracy of pdb alias example (GH-102892)
(cherry picked from commit e0c63b7267)

Co-authored-by: gaogaotiantian <gaogaotiantian@hotmail.com>
2023-03-22 04:44:21 -07:00
Miss Islington (bot) 1eb9b24929
Add link to `sys.exit` function documentation (GH-102805)
* Add link to `sys.exit` function documentation

* Update Doc/library/os.rst

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

* Update Doc/library/os.rst

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>

---------

(cherry picked from commit 41ef502d74)

Co-authored-by: David Poirier <1152277+david-poirier@users.noreply.github.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-21 15:06:10 -07:00
Raymond Hettinger e6e3b1b27d
[3.11] Backport itertool recipe updates (GH-102881) 2023-03-21 13:44:32 -05:00
Miss Islington (bot) df399a35d5
[3.11] Fix outdated note about 'int' rounding or truncating (GH-102736) (#102766)
Fix outdated note about 'int' rounding or truncating (GH-102736)
(cherry picked from commit 405739f916)

Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-03-16 20:42:54 +00:00
Miss Islington (bot) 4a7faac557
GH-102653: Make recipe docstring show the correct distribution (GH-102742)
(cherry picked from commit b0ec6253c9)

Co-authored-by: Raymond Hettinger <rhettinger@users.noreply.github.com>
2023-03-16 07:42:23 -07:00
Miss Islington (bot) 3ddf397217
gh-101100: Documenting --prefix and --exec-prefix. (GH-102695)
(cherry picked from commit 61b9ff35cb)

Co-authored-by: Julien Palard <julien@palard.fr>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-03-15 15:13:48 -07:00
Hugo van Kemenade 6b6c2f53ec
[3.11] Remove misformatted exclamation marks in docs (GH-102694) (#102716)
Remove the exclamation mark from :program:`!foo` in .rst files because
it inadvertently shows up in the rendered HTML.

(Sphinx's cross-referencing roles use a '!' prefix to suppress
hyperlinking[1], but :program: is not a cross-referencing role so the
'!' is displayed verbatim.)

The exclamation marks in venv.rst were introduced in #98350. See
comments [2] and [3] for additional discussion.

[1]: https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#cross-referencing-syntax
[2]: https://github.com/python/cpython/pull/98350#issuecomment-1285965759
[3]: https://github.com/python/cpython/pull/98350#issuecomment-1286394047

Reported-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Tom Levy <tomlevy93@gmail.com>
2023-03-15 09:25:55 +02:00
Miss Islington (bot) 738dde303b
[3.11] gh-102354: change python3 to python in docs examples (GH-102696) (#102697)
gh-102354: change python3 to python in docs examples (GH-102696)
(cherry picked from commit 80abd62647)

Co-authored-by: Paul Watson <paul.hermeneutic@gmail.com>
2023-03-14 12:52:33 -06:00
Miss Islington (bot) 0f46d42eb9
doc: Remove a duplicate 'versionchanged' in library/asyncio-task (gh-102677)
(cherry picked from commit 7bdb331b67)

Co-authored-by: Joongi Kim <me@daybreaker.info>
2023-03-13 19:26:11 -07:00
Miss Islington (bot) 43f8082b1c
gh-102627: Replace address pointing toward malicious web page (GH-102630)
* Replace known bad address pointing toward a malicious web page.

(cherry picked from commit 61479d4684)

Co-authored-by: Blind4Basics <32236948+Blind4Basics@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-03-13 15:43:16 -07:00
Alex Waygood a4fcd06c50
[3.11] Fix duplicated words in the docs (#102644)
(cherry-picked from commit f6ca71a422)

With grep utility found some duplicated words

Co-authored-by: Виталий Дмитриев <vitaldmit@bk.ru>
2023-03-13 14:31:50 +00:00
Miss Islington (bot) c39a1d0ba9
gh-101100: Fix Sphinx warnings in `turtle` module (GH-102340)
(cherry picked from commit 78e4e6c3d7)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-03-13 04:33:38 -07:00
Miss Islington (bot) 6829b1256a
[3.11] Fixes duplicated word (GH-102623) (#102624)
Fixes duplicated word (GH-102623)

In line 1627, the end of the sentence reads "only that that it may be." but it should read "only that it may be" (or alternatively "only that that may be").

(cherry picked from commit e6210621be)

Co-authored-by: Guido van Rossum <guido@python.org>
Co-authored-by: Hugo Gabriel Eyherabide <hugogabriel.eyherabide@gmail.com>
2023-03-12 10:00:04 -07:00
Miss Islington (bot) 495cd2de77
gh-86509: Add link to Lib/_threading_local.py in threading docs (GH-101824)
(cherry picked from commit 53dceb53ad)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-03-10 04:30:24 -08:00
Miss Islington (bot) ffb41eaaf4
gh-101100: Fix sphinx warnings in `zipapp` and `zipfile` modules (GH-102526)
(cherry picked from commit 1f557f94c2)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-03-08 00:30:44 -08:00
Miss Islington (bot) 8bf8e3d9a0
Fix style in argparse.rst (GH-101733)
(cherry picked from commit 061325e0d2)

Co-authored-by: Marcin Wieczorek <marcin@marcin.co>
2023-03-07 23:33:52 -08:00
Miss Islington (bot) caff048cb3
[3.11] Move around example in to_bytes() to avoid confusion (GH-101595) (#102434)
Move around example in to_bytes() to avoid confusion (GH-101595)

Moves an example to be closer to the sentence that refers to it.
(cherry picked from commit 5da379ca7d)

Co-authored-by: Sergey B Kirpichev <skirpichev@gmail.com>
2023-03-05 09:42:36 +00:00
Ilya Kulakov cda1d52ab8
[3.11] Clarify re docs for byte pattern group names (GH-99308) (#101001)
Fix wording of the deprecation notice in re for 3.11
2023-03-04 13:36:42 -08:00
Miss Islington (bot) 32a738e5b3
gh-101754: Document that Windows converts keys in `os.environ` to uppercase (GH-101840)
(cherry picked from commit 4e7c0cbf59)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-03-03 03:00:06 -08:00
Alex Waygood 3b1201daf6
[3.11] Fix typos in documentation and comments (GH-102374) (#102376)
[3.11] Fix typos in documentation and comments (GH-102374)

Found some duplicate `to`s in the documentation and some code comments and fixed them.

[Misc/NEWS.d/3.12.0a1.rst](ed55c69ebd/Misc/NEWS.d/3.12.0a1.rst) also contains two duplicate `to`s, but I wasn't sure if it's ok to touch that file.  Looks auto generated.  I'm happy to amend the PR if requested. :)

Automerge-Triggered-By: GH:AlexWaygood

Co-authored-by: Michael K <michael-k@users.noreply.github.com>
2023-03-02 16:00:06 +00:00
Hugo van Kemenade 9a5f2e8562
[3.11] gh-90744: Fix erroneous doc links in the sys module (GH-101319) (#102321)
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Brad Wolfe <brad.wolfe@gmail.com>
Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Fix erroneous doc links in the sys module (#101319)
2023-03-02 07:43:44 +02:00
Miss Islington (bot) 3effccee48
[3.11] gh-102088 Optimize iter_index itertools recipe (GH-102360) (GH-102363) 2023-03-01 21:52:37 -06:00
Miss Islington (bot) 1ef6e45f96
gh-102296 Document that inspect.Parameter kinds support ordering (GH-102297)
(cherry picked from commit 0db6f44259)

Co-authored-by: Gouvernathor <44340603+Gouvernathor@users.noreply.github.com>
Automerge-Triggered-By: GH:AlexWaygood
2023-02-27 07:21:27 -08:00
Miss Islington (bot) bd4a709038
gh-101100: Fix sphinx warnings in `types` module (GH-102274)
(cherry picked from commit 101a12c576)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-26 23:33:05 -08:00
Miss Islington (bot) 626f471d88
[3.11] gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046) (#102276)
gh-85417: Clarify behaviour on branch cuts in cmath module (GH-102046)

This PR updates the cmath module documentation to reflect the reality that Python is almost always (and as far as I can tell, that "almost" can be omitted) running on a machine whose C double supports signed zeros.

* Removes misleading references to functions being continuous from above / below / the left / the right at branch cuts
* Expands the note on branch cuts at the top of the module documentation to explain the double-sided sign-of-zero-based behaviour
(cherry picked from commit b513c46d99)

Co-authored-by: Mark Dickinson <dickinsm@gmail.com>
2023-02-26 11:55:25 +00:00
Miss Islington (bot) 7a0dc8a802
gh-102259: Fix re doc issue regarding right square brackets (GH-102264)
(cherry picked from commit bcadcde712)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-25 18:32:42 -08:00
Shantanu 735ff5ae27
[3.11] GH-99818: improve the documentation for zipfile.Path and Traversable (GH-101589) (#102266)
Automerge-Triggered-By: GH:FFY00
(cherry picked from commit 84181c1404)

Co-authored-by: Filipe Laíns <lains@riseup.net>
2023-02-25 23:42:30 +00:00
Miss Islington (bot) c2f42f1778
gh-101100: Fix sphinx warnings in `typing` module docs (GH-102260)
(cherry picked from commit a498de4c0e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-02-25 13:55:49 -08:00
Miss Islington (bot) 5775863e9d
asyncio docs: Fix dangling hyphen (GH-102227)
Currently this gets rendered with a dangling hyphen.
(cherry picked from commit 207e1c5cae)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-02-25 05:29:35 -08:00
Miss Islington (bot) a109ce00de
gh-101100: Fix Sphinx warnings in `decimal` module (GH-102125)
(cherry picked from commit b7c1126447)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-25 01:58:52 -08:00
Miss Islington (bot) 3b4f8fc83d
gh-102105 Fix wording in filterfalse/quantify/filter (GH-102189)
(cherry picked from commit 81bf10e4f2)

Co-authored-by: Stefan Pochmann <609905+pochmann@users.noreply.github.com>
2023-02-24 08:21:40 -08:00
Miss Islington (bot) 42d0ca92ed
[3.11] gh-100226: Clarify StreamReader.read behavior (GH-101807) (#102001)
gh-100226: Clarify StreamReader.read behavior (GH-101807)
(cherry picked from commit 77d95c8373)

Co-authored-by: Jan Gosmann <jan@hyper-world.de>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-02-23 19:05:59 +05:30
Miss Islington (bot) bf0a8362cd
Fix syntax error in struct doc example (GH-102160)
Missing closing ) reported on Discuss by Chukwudi Nwachukwu.
(cherry picked from commit 8f647477f0)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-22 16:02:31 -08:00
Miss Islington (bot) 8b5498e367
GH-101777: `queue.rst`: use 2 spaces after a period to be consistent. (GH-102143)
(cherry picked from commit 96bf24380e)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-22 13:39:05 -08:00
Miss Islington (bot) 528e91c067
[3.11] gh-102135: Update turtle docs to rename wikipedia demo to rosette (GH-102137) (GH-102138)
(cherry picked from commit 8d46c7ed5e)

Co-authored-by: somebody <98094921+UndoneStudios@users.noreply.github.com>

Automerge-Triggered-By: GH:hugovk
2023-02-22 02:25:17 -08:00
Miss Islington (bot) 78eee76185
gh-102011: use sys.exception() instead of sys.exc_info() in docs where possible (GH-102012)
(cherry picked from commit 4d3bc89a3f)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2023-02-21 03:06:20 -08:00
Miss Islington (bot) a94f3ad10b
gh-100556: Improve clarity of `or` docs (GH-100589)
(cherry picked from commit b40dd71241)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-02-21 02:45:49 -08:00
Miss Islington (bot) f94ffcf618
gh-101777: Make `PriorityQueue` docs slightly clearer (GH-102026)
Adjust wording slightly, and use min(entries) instead of
sorted(list(entries))[0] as an example.
(cherry picked from commit 350ba7c07f)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-21 02:32:58 -08:00
Miss Islington (bot) 4969903f7e
gh-99735: Use required=True in argparse subparsers example (GH-100927)
(cherry picked from commit 6aab56f3c2)

Co-authored-by: Patricio Paez <nospam@pp.com.mx>
2023-02-19 11:11:40 -08:00
Miss Islington (bot) 62db23c944
Fix incorrectly documented attribute in csv docs (GH-101250)
(cherry picked from commit 36b670908b)

Co-authored-by: Reza Rastak <rezarastak@users.noreply.github.com>
2023-02-18 17:04:01 -08:00
Brian Skinn 5220c2df9e
[3.11] gh-85747: Active voice & suggested edits, 'running/stopping loop' & 'callbacks' subsections of asyncio-eventloop.rst (GH-100270) (#102006)
Note: the `timeout` parameter was not added until 3.12.

(cherry picked from commit c4de6b1d52)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>.
Co-authored-by: Brian Skinn <brian.skinn@gmail.com>
2023-02-18 15:57:06 -08:00
Miss Islington (bot) b7a49eb5ff
gh-101739: [Enum] update docs - default boundary for Flag is CONFORM (GH-101746)
(cherry picked from commit 7f1c721756)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-02-17 13:44:45 -08:00
Miss Islington (bot) be69ac3c96
gh-101992: update plistlib examples to be runnable (GH-101994)
* gh-101992: update plistlib examples to be runnable

* Update Doc/library/plistlib.rst

---------

(cherry picked from commit a1723caabf)

Co-authored-by: Dustin Rodrigues <dust.rod@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2023-02-17 11:39:14 -08:00
Miss Islington (bot) aedf38391a
gh-93573: Replace wrong example domains in configparser doc (GH-93574)
* Replace bitbucket.org domain by forge.example
* Update example to python.org
* Use explicitly invalid domain

topsecret.server.com domain is not controled by PSF. It's replaced by invalid topsecret.server.example domain. It follows RFC 2606, which advise .example as TLD for documentation.
(cherry picked from commit 924a3bfa28)

Co-authored-by: sblondon <stephane.blondon@gmail.com>
2023-02-16 07:25:31 -08:00
Miss Islington (bot) 4aeae28671
GH-101898: Fix missing term references for hashable definition (GH-101899)
Fix missing term references for hashable definition
(cherry picked from commit 3690688149)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2023-02-14 02:45:42 -08:00
Miss Islington (bot) 01b21c320b
Correct trivial grammar in reset_mock docs (GH-101861)
(cherry picked from commit a1f08f5f19)

Co-authored-by: Steve Kowalik <steven@wedontsleep.org>
2023-02-13 01:20:18 -08:00
Miss Islington (bot) 91fb7c36a3
[3.11] gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properly call it a class method (GH-101391) (#GH-101813)
gh-101390: Fix docs for `imporlib.util.LazyLoader.factory` to properly call it a class method (GH-101391)
(cherry picked from commit 17143e2c30)

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2023-02-10 16:24:28 -08:00
Hugo van Kemenade c485f0e39e
[3.11] Docs: Fix getstatus() -> getcode() typos (GH-101296) (#101805) 2023-02-11 00:26:41 +02:00
Miss Islington (bot) 18313ecb09
Docs: use parameter list for sqlite3.Cursor.execute* (GH-101782)
(cherry picked from commit 2037ebf81b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2023-02-10 10:01:38 -08:00
Miss Islington (bot) 4a9dff0e5a
gh-101283: Version was just released, so should be changed in 3.11.3 (GH-101719)
(cherry picked from commit 0e0c5d8baa)

Co-authored-by: Steve Dower <steve.dower@python.org>
2023-02-08 16:11:36 -08:00
Miss Islington (bot) 51b079a2d6
Update Lib/subprocess.py 2023-02-08 15:44:06 -08:00
Miss Islington (bot) 7240ba7f94
[3.11] gh-47937: Note that Popen attributes are read-only (GH-93070) (#101684)
* Note that Popen attributes aren't meant to be set by users by rewording the text about the attributes.
* Also update some universal_newlines references to mention the modern text parameter name while in the area.

(cherry picked from commit 027adf42cd)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
2023-02-08 11:03:56 +01:00
Oleg Iarygin fa90671480
[3.11] gh-97725: Fix documentation for the default file of `asyncio.Task.print_stack` (#101652) (#101653)
(cherry picked from commit f87f6e2396)
2023-02-08 11:02:37 +01:00
Miss Islington (bot) 7cbcfbe2ff
GH-56426: Add cross-reference to the documentation for faulthandler, traceback, and pdb. (GH-101157)
(cherry picked from commit cef9de62b8)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-03 19:56:57 -08:00
Miss Islington (bot) 2366c1a4fe
gh-100920: Update documentation for `asyncio.StreamWriter.wait_closed` (GH-101514)
(cherry picked from commit 5c39daf50b)

Co-authored-by: Viet Than <thanhoangviet@gmail.com>
2023-02-02 23:26:37 -08:00
Miss Islington (bot) bfac5d9850
gh-100925: Move array methods under class in array doc (GH-101485)
* Move array methods under class in array doc

* Fix a few internal references related to the touched lines
(cherry picked from commit 1b6045668d)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-02 16:12:09 -08:00
Miss Islington (bot) 08f5c77359
docs: Fix enum reassign `str` documentation (GH-101507)
(cherry picked from commit 24cbc7a2a0)

Co-authored-by: Peter Gessler <gesslerpd@users.noreply.github.com>
2023-02-02 12:40:30 -08:00
Miss Islington (bot) c2c970fc26
Docs: improve accuracy of sqlite3 `check_same_thread` parameter (GH-101351)
(cherry picked from commit ee21110086)

Co-authored-by: Marcos Pereira <3464445+marcospgp@users.noreply.github.com>
Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-02-01 16:00:27 -08:00
Miss Islington (bot) 89442e18e1
gh-101498 : Fix asyncio.Timeout example in docs (GH-101499)
Doc/library/asyncio-task.rstGH-timeout
(cherry picked from commit 95fb0e0258)

Co-authored-by: Raj <51259329+workingpayload@users.noreply.github.com>
2023-02-01 10:19:11 -08:00
Irit Katriel c796d34b2a
[3.11] gh-101454: fix documentation for END_ASYNC_FOR (#101455) (#101493)
gh-101454: fix documentation for END_ASYNC_FOR (#101455)

(cherry picked from commit 62251c3da0)
2023-02-01 14:30:48 +00:00
Miss Islington (bot) 85cc5d0e5d
gh-98657: [docs] `array.typecodes` is a module-level attribute (GH-98729)
* gh-98657: [docs] `array.typecodes` is a module-level attribute

* Update array.rst
(cherry picked from commit c144e57b31)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2023-01-31 21:48:19 -08:00
Miss Islington (bot) a79dd88973
gh-77607: Improve accuracy of os.path.join docs (GH-101406)
This is a follow-up to GH-100811.

One of the changes in that PR isn't accurate in that
`os.path.join('', '')` will not end in a separator.

This reverts that change to the previous wording that used "only", but
explicitly calls out the case where the last part ends in a separator,
which is what caused confusin in GH-77607 and motivated the change
in GH-100811.
(cherry picked from commit 909a674693)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-30 21:46:48 -08:00
Miss Islington (bot) 6a94f4c973
Fixes typo in asyncio.TaskGroup context manager code example (GH-101449)
(cherry picked from commit ef09bf63d2)

Co-authored-by: Ben <22038077+bcla22@users.noreply.github.com>
2023-01-30 21:46:35 -08:00
Miss Islington (bot) 6ec9f2d5b8
gh-101422: (docs) TarFile default errorlevel argument is 1, not 0 (GH-101424)
(cherry picked from commit ea232716d3)

Co-authored-by: Owain Davies <116417456+OTheDev@users.noreply.github.com>
2023-01-30 10:10:26 -08:00
Miss Islington (bot) 3bcb630e07
gh-98240: Updated Path.rename docs, when it is atomic (GH-98245)
(cherry picked from commit 0023f51deb)

Co-authored-by: Mateusz <mateka@users.noreply.github.com>
2023-01-29 17:52:29 -08:00
Miss Islington (bot) 88a1e6db0f
[3.11] [doc] Add a section on logging handler configuration order. (GH-101380) (GH-101382)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 19:12:18 +00:00
Miss Islington (bot) 1016909a6d
[3.11] [doc] Add some notices to logging configuration documentation. (GH-101373) (GH-101376)
Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
2023-01-27 17:45:59 +00:00
Miss Islington (bot) 4cf4169350
Added asyncio REPL example to docs. (GH-101243)
(cherry picked from commit 5d868efde9)

Co-authored-by: Carlton Gibson <carlton.gibson@noumenal.es>
Co-authored-by: Kumar Aditya <59607654+kumaraditya303@users.noreply.github.com>
2023-01-23 03:39:01 -08:00
Miss Islington (bot) 69d12d868e
[3.11] GH-101097: Switch from standard interval notation to greater or less than signs for random.random()'s documentation (GH-101119) (GH-101246)
(cherry picked from commit 8bcd4a6ec7)

Co-authored-by: Andrew Hong <andrewhong@myyahoo.com>

Automerge-Triggered-By: GH:rhettinger
2023-01-22 13:45:55 -08:00
Miss Islington (bot) db0eeb381e
[3.11] gh-86610: Use attribute directive in docs for pathlib.PurePath (GH-101114) (#101205)
(cherry picked from commit 01093b8203)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
2023-01-20 23:28:21 +01:00
Miss Islington (bot) efc89f3454
[3.11] GH-101111: Disambigaute origin of const for store_const and append_const (GH-101121) (#101203)
(cherry picked from commit 9a155138c5)

While the documentation for `optparse` mentioned that both `store_const` and
`append_const` store a constant value, it was not clear where this value was
coming from.

A link to `Option.const` makes this explicit.

Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>
2023-01-20 23:22:04 +01:00
Miss Islington (bot) 1798df2b40
[3.11] Fix minor typos in SSL documentation (GH-101158) (#101201)
(cherry picked from commit 73497690b5)

Co-authored-by: Simon Robinson <simon@robinson.ac>
2023-01-20 23:18:25 +01:00
Miss Islington (bot) 0dc35e4bbb
gh-91485: Avoid unnecessary use of non-Python syntax in io docs (GH-101177)
(cherry picked from commit 783d1bc51b)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-20 14:12:26 -08:00
Miss Islington (bot) e039d53dae
[3.11] gh-101100: [Enum] Fix sphinx warnings in docs (GH-101122) (#101173)
(cherry picked from commit 9e025d305f)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-20 23:07:23 +01:00
Gregory P. Smith efe3a389ca
[3.11] gh-101144: Allow zipfile.Path .open & .read_text encoding to be positional (#101179)
The zipfile.Path open() and read_text() encoding parameter can be supplied as a positional argument without causing a TypeError again. 3.10.0b1 included a regression that made it keyword only.

Documentation update included as users writing code to be compatible with a wide range of versions will need to consider this for some time..

(cherry picked from commit 5927013e47)

Co-authored-by: Gregory P. Smith <greg@krypto.org> [Google]
2023-01-20 00:06:18 -08:00
Miss Islington (bot) 1998ea69c7
gh-101041: Fix a misspelled name of `utctimetuple` in a doc warning (GH-101042)
(cherry picked from commit 8e9d08b062)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2023-01-19 21:06:47 -08:00
Miss Islington (bot) db65a326a4
Docs: improve sqlite3 placeholders example (GH-101092)
(cherry picked from commit b84be8d9c0)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
2023-01-18 01:43:44 -08:00
Miss Islington (bot) 5e52778b1a
Fix typo in `ReprEnum` documentation (GH-101079)
(cherry picked from commit c5660ae96f)

Co-authored-by: Viicos <65306057+Viicos@users.noreply.github.com>
2023-01-17 02:59:35 -08:00
Miss Islington (bot) 6d98282ed4
[3.11] Sync-up parameter name in equivalent code snippet of `enumerate` (GH-101029) (#101030)
Sync-up parameter name in equivalent code snippet of `enumerate` (GH-101029)
(cherry picked from commit ef633e5000)

Co-authored-by: JustAnotherArchivist <JustAnotherArchivist@users.noreply.github.com>
2023-01-15 12:16:06 +05:30
Miss Islington (bot) c7aa39286b
gh-100668: Clarify how sqlite3 maps parameters onto placeholders (GH-100960)
(cherry picked from commit 206f05a46b)

Co-authored-by: Erlend E. Aasland <erlend.aasland@protonmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2023-01-14 15:04:53 -08:00
Miss Islington (bot) 39c1f68fff
gh-101021: Document binary parameters as bytes (GH-101024)
(cherry picked from commit 49cae39ef0)

Co-authored-by: Bob Kline <bkline@users.noreply.github.com>
2023-01-14 12:22:08 -08:00
Raymond Hettinger ba88628808
[3.11] Add recipes to showcase tee(), zip*, batched, starmap, and product. (GH-101028) 2023-01-13 22:32:32 -06:00
Serhiy Storchaka 2834fdc689
[3.11] gh-100160: Tweak the documentation for the default asyncio policy (GH-100969) 2023-01-13 10:15:23 +02:00
Miss Islington (bot) 75717645bc
Fix typo in `enum` module documentation (GH-100992)
(cherry picked from commit 2161bbf243)

Co-authored-by: Noam Cohen <noam@noam.me>
2023-01-12 07:51:11 -08:00
Miss Islington (bot) e8097d49f6
GH-100894: Updated the doc for `sys.winver` to clarify its usual contents (GH-100913)
(cherry picked from commit d9dff4c8b5)

Co-authored-by: ram vikram singh <ramvikrams243@gmail.com>
2023-01-11 16:21:07 -08:00
Serhiy Storchaka 1b2459dc64
[3.11] gh-100160: Remove any deprecation warnings in asyncio.get_event_loop() (#100412)
Some deprecation warnings will reappear (in a slightly different form) in 3.12.

Co-authored-by: Guido van Rossum <guido@python.org>
2023-01-10 12:20:09 -08:00
Hugo van Kemenade 1e74a12bde
[3.11] Fix typos in Doc folder (GH-100880). (#100914)
Co-authored-by: Semen Zhydenko <semen.zhydenko@gmail.com>
2023-01-10 11:42:03 +02:00
Miss Islington (bot) 4e096ec647
bpo-28356: Document os.rename() behavior on Windows for differing volumes (GH-27376)
(cherry picked from commit e098137cd3)

Co-authored-by: Ryan Ozawa <ryan.ozawa21@gmail.com>
2023-01-09 13:52:43 -08:00
Miss Islington (bot) 87076d880c
gh-100783: fix os.path.join documentation (GH-100811)
- Use "drive", not "drive letter", because of UNC paths
- Previous components are not thrown away from relative drive letters
- Use "segment" instead of "component" for consistency with pathlib
- Other miscellaneous improvements
(cherry picked from commit 53455a319f)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-01-08 01:22:44 -08:00
Miss Islington (bot) caed845fb5
gh-100824: Fix typo in the documentation of unittest.TestLoader.testNamePatterns (GH-100825)
(cherry picked from commit 6d3bc4a795)

Co-authored-by: busywhitespace <busywhitespace@tuta.io>
2023-01-08 00:16:49 -08:00
Raymond Hettinger 4b4e6da7b5
[3.11] Future-proof recipe by renaming dotproduct() to sumprod() (GH-100828) 2023-01-07 15:16:38 -06:00
Miss Islington (bot) a3e2407f5c
gh-100673: Removed erroneous note in the get_type_hints docs (GH-100701)
Removed erroneous note in the get_type_hints docs

typing.get_type_hints still includes base class type hints.
(cherry picked from commit deaf090699)

Co-authored-by: FrozenBob <30644137+FrozenBob@users.noreply.github.com>
2023-01-07 09:38:32 -08:00
Miss Islington (bot) 72263f2a20
gh-99026 update dataclasses docs for when annotations are inspected (gh-100798)
update dataclasses docs for when annotations are inspected
(cherry picked from commit 659c2607f5)

Co-authored-by: Akshit Tyagi <37214399+exitflynn@users.noreply.github.com>
2023-01-06 06:34:30 -08:00
Miss Islington (bot) d6b8413e94
gh-87691: clarify use of anchor in pathlib docs (GH-100782)
This is feedback from https://github.com/python/cpython/pull/100737GH-discussion_r1062968696

This matches the wording from the `os.path.join` docs better:
https://docs.python.org/3/library/os.path.htmlGH-os.path.join

In particular, the previous use of "anchor" was incorrect given the
pathlib definition of "anchor".

(cherry picked from commit 2f2fa03ff3)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Co-authored-by: Barney Gale <barney.gale@gmail.com>
2023-01-05 17:59:27 -08:00
Miss Islington (bot) 75861006d8
gh-87691: add an absolute path pathlib example in / operator docs (GH-100737)
The behaviour is fully explained a couple paragraphs above, but it may be useful to have a brief example to cover the behaviour.
(cherry picked from commit 1ae619c911)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
Automerge-Triggered-By: GH:hauntsaninja
2023-01-05 15:04:39 -08:00