Commit graph

27382 commits

Author SHA1 Message Date
Miss Islington (bot)
b7c633fbfc
[3.12] gh-112020: Document the meaning of empty bytes returned by socket.recv() (GH-112055) (GH-115722)
(cherry picked from commit e71468ba4f)

Co-authored-by: talcs <talh8787@gmail.com>
2024-02-20 15:01:31 +00:00
Miss Islington (bot)
82e01a8b6d
[3.12] Make the title match the content (GH-115702) (gh-115703) 2024-02-20 07:58:53 +00:00
Miss Islington (bot)
8f70b33975
[3.12] Modernize the Sorting HowTo guide (gh-115479) (gh-115701) 2024-02-20 03:28:23 +00:00
Miss Islington (bot)
db145c72b8
[3.12] Fix typo in multiprocessing docs (GH-115650) (#115679)
(cherry picked from commit 57d31ec359)

Co-authored-by: Naglis Jonaitis <827324+naglis@users.noreply.github.com>
2024-02-19 18:25:24 +00:00
Miss Islington (bot)
b434439bfb
[3.12] gh-115664: Fix versionadded and versionchanged directives in multiprocessing.rst (GH-115665) (GH-115677)
(cherry picked from commit 8f602981ba)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-02-19 20:21:10 +02:00
Brian Schubert
773d53d3c1
[3.12] gh-115664: Fix chronological ordering of versionadded and versionchanged directives (GH-115676) (#115678) 2024-02-19 18:18:38 +00:00
Miss Islington (bot)
94d1a7b853
[3.12] gh-115652: Fix indentation in the documentation of multiprocessing.get_start_method (GH-115658) (GH-115659)
(cherry picked from commit d504968983)

Co-authored-by: Daniel Haag <121057143+denialhaag@users.noreply.github.com>
2024-02-19 17:09:21 +02:00
Miss Islington (bot)
8a5731e7db
[3.12] Docs: Add explanation about little/big endian (GH-109841) (#115646)
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:56:54 +00:00
Kirill Podoprigora
ae6c01d9d2
[3.12] gh-115572: Move codeobject.replace() docs to the data model … (#115633)
* [3.12] 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:38:33 +00:00
Miss Islington (bot)
2763f382f9
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/3.2.rst (GH-115580) (#115589)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-17 14:18:30 -07:00
Miss Islington (bot)
c726d1cc67
[3.12] Document use of ANY in test assertions (GH-94060) (GH-115607)
(cherry picked from commit 04005f5021)

Co-authored-by: Thomas Grainger <tagrain@gmail.com>
2024-02-17 13:24:20 +00:00
Miss Islington (bot)
a086dd313e
[3.12] gh-101699: Explain using Match.expand with \g<0> (GH-101701) (GH-115583)
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:04:09 +02:00
Miss Islington (bot)
068e2190de
[3.12] gh-87688: Amend SSLContext.hostname_checks_common_name docs (GH-100517) (GH-115594)
(cherry picked from commit debb1386be)

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

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2024-02-17 14:57:22 +02:00
Miss Islington (bot)
d46a2a0008
[3.12] gh-97590: Update docs and tests for ftplib.FTP.voidcmd() (GH-96825) (GH-115601)
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:50 +02:00
Miss Islington (bot)
ebf8eb2740
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/3.1.rst (GH-115575) (#115587)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-17 02:47:46 -07:00
Miss Islington (bot)
d08d5b6251
[3.12] docs: Add glossary term references to shutil docs (GH-115559) (#115578)
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:49 +00:00
Miss Islington (bot)
f383ca1a6f
[3.12] gh-100734: What's New in 3.x: Add missing detail from 3.x branch (GH-114689) (#115526)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-15 17:44:47 +02:00
Miss Islington (bot)
7d9ce3c867
[3.12] Docs: spell out sentence about ndbm/gdbm file formats (GH-115470) (#115476)
(cherry picked from commit 49e8fdc1df)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-14 18:11:43 +00:00
Miss Islington (bot)
59317167eb
[3.12] Docs: reword sentences about dbm submodule traits (GH-114609) (#115462)
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:55:48 +00:00
Miss Islington (bot)
d5f7b07e92
[3.12] gh-115403: Remove extra colon after "Examples" in datetime documentation (GH-115452) (#115455)
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:55 +03:00
Miss Islington (bot)
644aeb5dbb
[3.12] ftplib docs: timeout doesn't have to be a whole number (GH-115443) (#115445)
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:47:59 +00:00
Miss Islington (bot)
03d2c3b804
[3.12] gh-113437: Update documentation about PyUnicode_AsWideChar() function (GH-113455) (GH-115407)
(cherry picked from commit 5719aa23ab)

Co-authored-by: qqwqqw689 <114795525+qqwqqw689@users.noreply.github.com>
2024-02-14 11:24:40 +01:00
Miss Islington (bot)
45e5599130
[3.12] gh-101100: Fix sphinx warnings in c-api/gcsupport.rst (GH-114786) (#115263)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-02-13 14:25:54 -07:00
Miss Islington (bot)
c2a3c3c643
[3.12] gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411) (#115412)
gh-115405: add versionadded tag for co_qualname in code objects documentation (GH-115411)
(cherry picked from commit de07941729)

Co-authored-by: Christophe Papazian <114495376+christophe-papazian@users.noreply.github.com>
2024-02-13 16:16:22 +00:00
Miss Islington (bot)
a30bb080dc
[3.12] Update "Using Python on a Mac" (GH-115024) (#115387)
Update "Using Python on a Mac" (GH-115024)
(cherry picked from commit 0a6e1a4119)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-13 09:05:46 +02:00
Miss Islington (bot)
1b36a8fc6a
[3.12] gh-115317: Rewrite changelog filter to use vanilla JavaScript (GH-115324) (#115372)
gh-115317: Rewrite changelog filter to use vanilla JavaScript (GH-115324)
(cherry picked from commit 341d7874f0)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Tomas R <tomas.roun8@gmail.com>
2024-02-13 07:29:31 +02:00
Serhiy Storchaka
225856ef3e
[3.12] gh-115233: Fix an example in the Logging Cookbook (GH-115325) (GH-115355)
Also add more tests for LoggerAdapter.

Also support stacklevel in LoggerAdapter._log().
(cherry picked from commit 91822018ee)
2024-02-12 18:29:48 +00:00
Hugo van Kemenade
5ec271db3b
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/2.7.rst and related (GH-115319) (#115330) 2024-02-12 16:37:20 +02:00
Miss Islington (bot)
67688609d2
[3.12] gh-101100: Clean up Doc/c-api/exceptions.rst and Doc/c-api/sys.rst (GH-114825) (GH-115308)
(cherry picked from commit e1552fd19d)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-02-11 19:02:21 +00:00
Skip Montanaro
18f5264145
[3.12] gh-101100: Fix dangling refs in bdb.rst (#114983) (#115297)
Co-authored-by: AN Long <aisk@users.noreply.github.com>
Fix dangling refs in bdb.rst (#114983)
2024-02-11 11:32:37 -07:00
Serhiy Storchaka
b9f560258c
[3.12] gh-115172: Fix explicit index extries for the C API (GH-115173) (GH-115292)
(cherry picked from commit 573acb30f2)
2024-02-11 10:34:41 +00:00
Miss Islington (bot)
7cc205872d
[3.12] gh-114552: Update __dir__ method docs: it allows returning an iterable (GH-114662) (#115234)
gh-114552: Update `__dir__` method docs: it allows returning an iterable (GH-114662)
(cherry picked from commit e19103a346)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-02-10 08:50:31 +00:00
Nikita Sobolev
3539b02873
[3.12] gh-101100: Fix sphinx warnings in library/enum.rst (GH-114696) (GH-115208) 2024-02-09 12:10:26 -08:00
Miss Islington (bot)
370cbbbfeb
[3.12] Docs: correctly link to code objects (GH-115214) (#115216)
(cherry picked from commit 769d444826)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-02-09 14:17:49 +00:00
Miss Islington (bot)
108ff59c8f
[3.12] gh-115106 docs: 'enum.Flag.__iter__()' did not exist prior to Python 3.11 (GH-115107) (GH-115117)
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:03:12 -08:00
Miss Islington (bot)
7d2f88edf0
[3.12] gh-114071: [Enum] update docs and code for tuples/subclasses (GH-114871) (GH-114993)
Update documentation with `__new__` and `__init__` entries.

Support use of `auto()` in tuple subclasses on member assignment lines.  Previously, auto() was only supported on the member definition line either solo or as part of a tuple:

    RED = auto()
    BLUE = auto(), 'azul'

However, since Python itself supports using tuple subclasses where tuples are expected, e.g.:

    from collections import namedtuple
    T = namedtuple('T', 'first second third')

    def test(one, two, three):
        print(one, two, three)

    test(*T(4, 5, 6))
    GH- 4 5 6

it made sense to also support tuple subclasses in enum definitions.
(cherry picked from commit ff7588b729)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2024-02-08 14:01:38 -08:00
Miss Islington (bot)
a69e68db60
[3.12] gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003) (#115135)
gh-101100: Fix Py_DEBUG dangling Sphinx references (GH-115003)
(cherry picked from commit d0322fdf2c)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-02-07 10:55:21 +00:00
Łukasz Langa
b39119916c
[3.12] gh-46968: Fix invalid reference to Sound eXchange (SoX) 12.17.7 license (#115094)
Fix invalid reference to Sound eXchange (SoX) 12.17.7 license
2024-02-06 18:59:23 +01:00
Miss Islington (bot)
21f06a22c0
[3.12] gh-114967: Fix "Built-in Exceptions" documentation ambiguous wording (GH-114968) (#115033)
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: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: HarryLHW <123lhw321@gmail.com>
2024-02-05 20:30:38 +00:00
Miss Islington (bot)
d334122d22
[3.12] GH-69695: Update `PyImport_ImportModule` description (GH-103836) GH-114925)
GH-69695: Update ``PyImport_ImportModule`` description (GH-103836)

(cherry picked from commit 9872855a31)

Co-authored-by: patenaud <33957588+patenaud@users.noreply.github.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-02-05 10:53:57 +01:00
Miss Islington (bot)
ae7fa9fa60
[3.12] Remove bogus syntax error marker in csv doc (GH-115017) (#115018)
(cherry picked from commit 39ec7fbba8)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-02-05 04:17:58 +00:00
Tian Gao
27cacdd5b4
[3.12] gh-114480: Add docs for f_trace_opcodes behavior on 3.12 (#114540) 2024-02-04 22:27:17 +00:00
Miss Islington (bot)
5d2e30958a
[3.12] gh-113803: Fix inaccurate documentation for shutil.move when dst is an existing directory (GH-113837) (#115006)
* 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:00:03 +00:00
Skip Montanaro
709a293467
[3.12] gh-101100: Fix dangling references in pickle.rst (#114972) (#114999)
gh-101100: Fix dangling references in pickle.rst (#114972)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit ec69e1d0dd)
2024-02-04 16:03:21 +00:00
Hugo van Kemenade
d8a787258d
[3.12] gh-101100: Fix Sphinx warnings from PEP 3108 stdlib re-organisation (GH-114327) (#114988)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Fix Sphinx warnings from PEP 3108 stdlib re-organisation (#114327)
2024-02-04 04:53:45 -07:00
Miss Islington (bot)
cf2ecbc514
[3.12] gh-101100: Fix sphinx warnings in c-api/file.rst (GH-114546) (#114584)
* gh-101100: Fix sphinx warnings in `c-api/file.rst` (GH-114546)
(cherry picked from commit 01d970c1b8)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-04 10:57:19 +02:00
Miss Islington (bot)
df9f3ef5a2
[3.12] gh-101100: Fix Sphinx reference warnings in the glossary (GH-114729) (#114969)
gh-101100: Fix Sphinx reference warnings in the glossary (GH-114729)
(cherry picked from commit ab76d37948)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-02-03 18:51:43 +00:00
Miss Islington (bot)
c86a9e662f
[3.12] gh-114955: Add clear to MutableSequence's mixin methods in document (gh-114956) (gh-114961) 2024-02-03 15:41:04 +00:00
Miss Islington (bot)
98a8590e73
[3.12] Update LOGGING example taken from Django docs. (GH-114903) (#114951)
Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2024-02-03 08:23:33 -07:00