Commit graph

12478 commits

Author SHA1 Message Date
Miss Islington (bot)
8813e5a2de
[3.11] gh-115811: Update documentation to add some Logger attributes. (GH-116109) (GH-116186)
(cherry picked from commit 3b6f4cadf1)
2024-03-01 08:58:24 +00:00
Shantanu
718172719f
[3.11] gh-115881: Document feature_version limitations (#115980) (#116174) 2024-03-01 01:56:53 +00:00
Miss Islington (bot)
da34d55f7f
[3.11] Fix rendering of null character in ast.rst (GH-116080) (#116161)
Fix rendering of null character in ast.rst (GH-116080)
(cherry picked from commit c04a981ff4)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2024-02-29 22:42:31 +00:00
Miss Islington (bot)
8014ffda1d
[3.11] gh-73580: Docs for tunnelling TLS through TLS (GH-22539) (GH-116150)
(cherry picked from commit 91c3c64237)

Co-authored-by: Carl Bordum Hansen <carl@bordum.dk>
2024-02-29 21:03:59 +00:00
Miss Islington (bot)
f4efc135b3
[3.11] Docs: mark up NotImplemented using the :data: role throughout the docs (GH-116135) (#116148)
(cherry picked from commit dbe44f150c)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-29 20:53:50 +00:00
Miss Islington (bot)
6e328371c5
[3.11] gh-115937: Remove implementation details from inspect.signature() docs (GH-116086) (#116107)
gh-115937: Remove implementation details from inspect.signature() docs (GH-116086)
(cherry picked from commit fb2e17b642)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-02-29 01:54:48 -08:00
Erlend E. Aasland
02bb367748
[3.11] GH-115986 Reorder pprint docs and amend some references (#116019) (#116064)
(cherry picked from commit 6c1c94dc51)

Introduce a new subsubsection, 'Functions', for module level functions,
and place it before the PrettyPrinter class reference.

Also:
- Fix pprint.pprint() references so they properly link to the module
  level function.
- Add links to sys.stdout.

Co-authored-by: Kerim Kabirov <39376984+Privat33r-dev@users.noreply.github.com>
2024-02-28 20:11:12 +00:00
Miss Islington (bot)
f225740211
[3.11] doc: Use super() in subclassed JSONEncoder examples (GH-115565) (GH-116046)
doc: Use super() in subclassed JSONEncoder examples (GH-115565)

Replace calls to `json.JSONEncoder.default(self, obj)`
by `super().default(obj)` within the examples of the documentation.
(cherry picked from commit 647053fed1)

Co-authored-by: Jan Max Meyer <jmm@phorward.de>
2024-02-28 14:08:40 +00:00
Miss Islington (bot)
cccd73dced
[3.11] gh-115315: Update time.rst to include microseconds field (%f) in chart (GH-115316) (#115991)
Co-authored-by: Tahoma Software <bacon@tahoma.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-27 15:40:33 +02:00
Miss Islington (bot)
0f7f5a4a6c
[3.11] Doc: Clarify the return type of Event.wait when timeout is used (GH-104168) (GH-115939)
(cherry picked from commit 37f5d06b1b)

Co-authored-by: Phil Elson <pelson.pub@gmail.com>
2024-02-26 09:59:32 +00:00
Miss Islington (bot)
f822070e7a
[3.11] gh-115921: Change 'equation' to 'expression' in random.rst (GH-115927) (#115929)
In uniform function entry.
(cherry picked from commit de0b4f95cb)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-26 03:57:48 +00:00
Carol Willing
2110ae80fa
[3.11] gh-101100: Fix broken xrefs in fcntl module doc (GH-115691) (#115925)
* clean up fcntl module doc

* simplify

* a few changes, based on suggestion by CAM-Gerlach

* nitpick ignore for a couple other C functions mentioned in the fcntl module doc

* more changes, especially related to LOCK_* constants

* :data: back to :const:

* Apply suggestions from code review



---------

(cherry picked from commit 84a275c4a2)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2024-02-26 01:32:52 +00:00
Miss Islington (bot)
6324d9b485
[3.11] gh-103417: Fix the scheduler example (GH-111497) (GH-115909)
Arguments to enterabs() are specified as Unix time.
If the scheduler use the time.monotonic timer, the code will take
decades to complete.
(cherry picked from commit cb287d3421)

Co-authored-by: mauricelambert <50479118+mauricelambert@users.noreply.github.com>
2024-02-25 14:04:47 +02:00
Miss Islington (bot)
c0789209c4
[3.11] Add an example of of custom __repr__ (GH-112761) (#115901)
Added to repr entry in Doc/library/functions.rst.

---------

(cherry picked from commit 5770006ffa)

Co-authored-by: Oh seungmin <tmdals179@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-25 08:06:37 +00:00
Miss Islington (bot)
92e43aea35
[3.11] Erase some unnecessary quotes on data model doc (GH-113521) (#115897)
Thanks to Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) for help with this bug.

(cherry picked from commit f7455864f2)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2024-02-24 23:30:34 -05:00
Miss Islington (bot)
7c2e1b2c8f
[3.11] Update http.cookiejar document for cookie object attributes (GH-101885) (#115834)
Update http.cookiejar document for cookie object attributes (GH-101885)
(cherry picked from commit a3859422d1)

Co-authored-by: NewUserHa <32261870+NewUserHa@users.noreply.github.com>
2024-02-23 14:11:09 -08:00
Miss Islington (bot)
5172247e8d
[3.11] gh-54358: Clarify data chunking in pyexpat (GH-31629) (GH-115865)
(cherry picked from commit 462a2fc09d)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
Co-authored-by: Éric Araujo <merwok@netwok.org>
2024-02-23 21:25:38 +02:00
Miss Islington (bot)
6928d5e1f7
[3.11] gh-115399: Document CVE-2023-52425 under "XML vulnerabilities" (GH-115400) (GH-115761)
Doc/library/xml.rst: Document CVE-2023-52425 under "XML vulnerabilities"
(cherry picked from commit fbd40ce46e)

Co-authored-by: Sebastian Pipping <sebastian@pipping.org>
2024-02-21 12:43:16 +01:00
Miss Islington (bot)
5a0d51b629
[3.11] gh-112020: Document the meaning of empty bytes returned by socket.recv() (GH-112055) (GH-115723)
(cherry picked from commit e71468ba4f)

Co-authored-by: talcs <talh8787@gmail.com>
2024-02-20 15:00:30 +00:00
Serhiy Storchaka
c39baf15c5
[3.11] gh-115664: Fix versionadded and versionchanged directives in multiprocessing.rst (GH-115665) (GH-115682)
(cherry picked from commit 8f602981ba)
2024-02-19 20:52:17 +02:00
Brian Schubert
61f2085687
[3.11] gh-115664: Fix chronological ordering of versionadded and versionchanged directives (GH-115676) (#115681)
Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
2024-02-19 18:42:19 +00:00
Miss Islington (bot)
f10ce9fede
[3.11] Fix typo in multiprocessing docs (GH-115650) (#115680)
(cherry picked from commit 57d31ec359)

Co-authored-by: Naglis Jonaitis <827324+naglis@users.noreply.github.com>
2024-02-19 18:25:59 +00:00
Miss Islington (bot)
d4915220e7
[3.11] gh-115652: Fix indentation in the documentation of multiprocessing.get_start_method (GH-115658) (GH-115660)
(cherry picked from commit d504968983)

Co-authored-by: Daniel Haag <121057143+denialhaag@users.noreply.github.com>
2024-02-19 17:09:07 +02:00
Miss Islington (bot)
eb759952ee
[3.11] Docs: Add explanation about little/big endian (GH-109841) (#115647)
Docs: Add explanation about little/big endian (GH-109841)
(cherry picked from commit 177b9cb52e)

Co-authored-by: Simon A. Eugster <simon.eu@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2024-02-19 07:57:00 +00:00
Kirill Podoprigora
c69da47ac9
[3.11] gh-115572: Move codeobject.replace() docs to the data model … (#115632)
* [3.11] gh-115572: Move `codeobject.replace()` docs to the data model (GH-115631)
(cherry picked from commit 0c80da4c14)

Co-authored-by: Daler <48939169+daler-sz@users.noreply.github.com>

* Remove note about copy.replace

---------

Co-authored-by: Daler <48939169+daler-sz@users.noreply.github.com>
2024-02-18 14:37:27 +00:00
Miss Islington (bot)
a6776cdc53
[3.11] Document use of ANY in test assertions (GH-94060) (GH-115608)
(cherry picked from commit 04005f5021)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2024-02-17 13:24:40 +00:00
Miss Islington (bot)
5b6e358913
[3.11] gh-101699: Explain using Match.expand with \g<0> (GH-101701) (GH-115584)
Update documentation for re library to explain that a backreference `\g<0>` is
expanded to the entire string when using Match.expand().
Note that numeric backreferences to group 0 (`\0`) are not supported.

(cherry picked from commit d2d7808853)

Co-authored-by: Stevoisiak <S.Vascellaro@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-02-17 15:03:43 +02:00
Miss Islington (bot)
bc11905d48
[3.11] gh-87688: Amend SSLContext.hostname_checks_common_name docs (GH-100517) (GH-115595)
(cherry picked from commit debb1386be)

Co-authored-by: Rami <72725910+ramikg@users.noreply.github.com>
2024-02-17 14:59:31 +02:00
Miss Islington (bot)
8fccca2f50
[3.11] gh-56499: Update the pickle library's note section for the __setstate__ function (GH-101062) (GH-115598)
(cherry picked from commit d5a30a1777)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2024-02-17 14:56:54 +02:00
Miss Islington (bot)
2c39d00a56
[3.11] gh-97590: Update docs and tests for ftplib.FTP.voidcmd() (GH-96825) (GH-115602)
Since 2f3941d743 this function returns the
response string, rather than nothing.
(cherry picked from commit e88ebc1c40)

Co-authored-by: Matthew Hughes <34972397+matthewhughes934@users.noreply.github.com>
2024-02-17 14:54:31 +02:00
Miss Islington (bot)
7de9caec0d
[3.11] docs: Add glossary term references to shutil docs (GH-115559) (#115579)
docs: Add glossary term references to shutil docs (GH-115559)

Add glossary term references to shutil docs
(cherry picked from commit 318f2190bc)

Co-authored-by: Brian Schubert <brianm.schubert@gmail.com>
2024-02-16 22:12:45 +00:00
Miss Islington (bot)
c12b0a25e8
[3.11] Docs: spell out sentence about ndbm/gdbm file formats (GH-115470) (#115477)
(cherry picked from commit 49e8fdc1df)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-14 18:10:06 +00:00
Miss Islington (bot)
7b94f47e68
[3.11] Docs: reword sentences about dbm submodule traits (GH-114609) (#115463)
Don't repeatedly say that keys and values are coerced into bytes.
(cherry picked from commit 81e140d10b)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-14 15:56:04 +00:00
Miss Islington (bot)
8dae36d1fb
[3.11] gh-115403: Remove extra colon after "Examples" in datetime documentation (GH-115452) (#115456)
gh-115403: Remove extra colon after "Examples" in datetime documentation (GH-115452)
(cherry picked from commit 6755c4e0c8)

Co-authored-by: Stanislav Lyu <wallseat@gmail.com>
2024-02-14 17:07:21 +03:00
Miss Islington (bot)
c274fe7534
[3.11] ftplib docs: timeout doesn't have to be a whole number (GH-115443) (#115446)
ftplib docs: `timeout` doesn't have to be a whole number (GH-115443)
(cherry picked from commit 3fd2ad8241)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-14 10:48:10 +00:00
Hugo van Kemenade
f0c58c6475
[3.11] gh-101100: Fix Sphinx warnings in whatsnew/2.7.rst and related (GH-115319) (#115331) 2024-02-12 16:37:28 +02:00
Serhiy Storchaka
446a6db5e1
[3.11] gh-115172: Fix explicit index extries for the C API (GH-115173) (GH-115293)
(cherry picked from commit 573acb30f2)
2024-02-11 10:42:28 +00:00
Miss Islington (bot)
dd28e82527
[3.11] gh-101100: Fix dangling refs in bdb.rst (GH-114983) (#115284)
gh-101100: Fix dangling refs in bdb.rst (GH-114983)
(cherry picked from commit 1b89591474)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: AN Long <aisk@users.noreply.github.com>
2024-02-11 09:28:03 +00:00
Nikita Sobolev
ca3eca1584
[3.11] gh-101100: Fix sphinx warnings in library/enum.rst (GH-114696) (GH-115209) 2024-02-09 12:09:59 -08:00
Miss Islington (bot)
21e3b31424
[3.11] gh-115106 docs: 'enum.Flag.__iter__()' did not exist prior to Python 3.11 (GH-115107) (GH-115118)
change versionchanged to versionadded
(cherry picked from commit 3f71c416c0)

Co-authored-by: Finite State Machine <38001514+finite-state-machine@users.noreply.github.com>
2024-02-08 14:02:45 -08:00
Miss Islington (bot)
98b2f4624a
[3.11] gh-114967: Fix "Built-in Exceptions" documentation ambiguous wording (GH-114968) (#115034)
Change the somewhat vague "listed below" to "listed in this chapter" in Doc/library/exceptions.rst.
The exceptions are listed in multiple sections after two intermediate sections.
---------
(cherry picked from commit 750489cc77)
Co-authored-by: HarryLHW <123lhw321@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-05 20:29:29 +00:00
Miss Islington (bot)
7f1c5578bb
[3.11] Remove bogus syntax error marker in csv doc (GH-115017) (#115019)
(cherry picked from commit 39ec7fbba8)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-05 04:18:02 +00:00
Miss Islington (bot)
fef6c9bbde
[3.11] gh-113803: Fix inaccurate documentation for shutil.move when dst is an existing directory (GH-113837) (#115007)
* fix the usage of dst and destination in shutil.move doc
* update shutil.move doc
(cherry picked from commit da8f9fb2ea)

Co-authored-by: Dai Wentao <dwt136@gmail.com>
2024-02-04 19:02:10 +00:00
Miss Islington (bot)
55e5ae70b3
[3.11] gh-101100: Fix dangling references in pickle.rst (GH-114972) (#114992)
gh-101100: Fix dangling references in pickle.rst (GH-114972)
(cherry picked from commit ec69e1d0dd)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-04 14:32:42 +00:00
Miss Islington (bot)
e9639e428a
[3.11] gh-114955: Add clear to MutableSequence's mixin methods in document (gh-114956) (#114962)
gh-114955: Add clear to MutableSequence's mixin methods in document (gh-114956)
(cherry picked from commit b4240fd68e)

Co-authored-by: AN Long <aisk@users.noreply.github.com>
2024-02-03 15:48:29 +00:00
Miss Islington (bot)
1956f7b229
[3.11] Normalize heading underline in multiprocessing.rst (GH-114923) (#114947)
This gets rid of the mildly confusing `>>>>>>>' underlines which look vaguely like `diff` punctuation.
(cherry picked from commit 00d7109075)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-02-03 02:02:15 +00:00
Miss Islington (bot)
b833b00482
[3.11] gh-114913: Add newline to subprocess doc (GH-114941) (#114943)
*creationflags* is a separate topic from *startupinfo*.
Start sentence with 'If given', like previous sentence.
(cherry picked from commit 1183f1e6bf)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-02 23:22:03 +00:00
Miss Islington (bot)
4e1360ae50
[3.11] Correct timedelta description (GH-101417) (GH-114939)
It only represents the difference between two datetime or
date objects, not between two time objects.
(cherry picked from commit 73d20cafb5)

Co-authored-by: John Belmonte <john@neggie.net>
2024-02-02 21:49:04 +00:00
Miss Islington (bot)
9bc79da844
[3.11] Fix indentation of "versionchanged" in datetime.rst (GH-114933) (GH-114936)
(cherry picked from commit b27812d632)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-02-02 23:18:25 +02:00
Miss Islington (bot)
df5381d8b6
[3.11] gh-103360: Add link in stdtypes.rst to escape sequences in lexical_analysis.rst (GH-103638) (#114908)
(cherry picked from commit d29f57f603)

Co-authored-by: Justin Williams <97240811+juswil@users.noreply.github.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-02 21:06:35 +00:00