Commit Graph

12461 Commits

Author SHA1 Message Date
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
Miss Islington (bot) 08133e4b58
[3.11] gh-114728: Fix documentation for comparison of objects in datetime module (GH-114749) (GH-114929)
(cherry picked from commit c12240ed28)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-02-02 18:59:28 +00:00
Miss Islington (bot) 1eb791ce4f
[3.11] Move "format" param doc of shutil.make_archive() on its own paragraph (GH-103829) (GH-114898)
(cherry picked from commit 53339a0ef7)

Co-authored-by: Michal Kaptur <kaptur.michal@gmail.com>
2024-02-02 12:28:15 +02:00
Miss Islington (bot) 3c30de1172
[3.11] gh-89891: Refer SharedMemory implementation as POSIX (GH-104678) (GH-114874)
It only uses POSIX API.
(cherry picked from commit 500ede0117)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2024-02-01 22:35:29 +02:00
Miss Islington (bot) 95f18f9738
[3.11] gh-101100: Fix sphinx warnings in `howto/logging.rst` (GH-114846) (#114872)
gh-101100: Fix sphinx warnings in `howto/logging.rst` (GH-114846)

(cherry picked from commit dc01b919c7)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-02-01 18:45:02 +00:00
Miss Islington (bot) a46fddfed3
[3.11] Correct description of inheriting from another class (GH-114660) (#114869)
"inherits <someclass>" grates to this reader. I think it should be "inherits from <someclass>".
(cherry picked from commit c9c6e04380)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-02-01 18:15:12 +00:00
Miss Islington (bot) 3acab9a676
[3.11] gh-105031: Clarify datetime documentation for ISO8601 (GH-105049) (GH-114867)
(cherry picked from commit e9dab65638)

Co-authored-by: Nicholas Hollander <31573882+nhhollander@users.noreply.github.com>
2024-02-01 19:33:55 +02:00
Miss Islington (bot) 8d2a193cf6
[3.11] Fix typos in ElementTree documentation (GH-108848) (GH-114855)
PI objects instead of comment objects.
(cherry picked from commit de6f97cd35)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2024-02-01 09:40:46 +00:00
Miss Islington (bot) fe0f544f33
[3.11] gh-111112: Avoid potential confusion in TCP server example. (GH-111113) (#114832)
gh-111112: Avoid potential confusion in TCP server example. (GH-111113)

Improve misleading TCP server docs and example.

socket.recv(), as documented by the Python reference documentation,
returns at most `bufsize` bytes, and the underlying TCP protocol means
there is no guaranteed correspondence between what is sent by the client
and what is received by the server.

This conflation could mislead readers into thinking that TCP is
datagram-based or has similar semantics, which will likely appear to
work for simple cases, but introduce difficult to reproduce bugs.
(cherry picked from commit a79a27242f)

Co-authored-by: Aidan Holm <alfh@google.com>
2024-02-01 00:50:58 +00:00
Miss Islington (bot) e66ad91f68
[3.11] Add note to `sys.orig_argv` clarifying the difference from `sys.argv` (GH-114630) (#114822)
Add note to `sys.orig_argv` clarifying the difference from `sys.argv` (GH-114630)
(cherry picked from commit 1836f674c0)

Co-authored-by: Bradley Reynolds <bradley.reynolds@darbia.dev>
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-01-31 21:40:20 +00:00
Miss Islington (bot) ad6233396a
[3.11] gh-101100: Fix class reference in library/test.rst (GH-114769) (GH-114793)
The text clearly seems to be referencing `TestFuncAcceptsSequencesMixin`,
for which no target is available. Name the class properly and suppress
the dangling reference.
(cherry picked from commit 7a93db4425)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-01-31 09:41:00 +00:00
Skip Montanaro a38bc7cad6
[3.11] gh-101100: Fix references in csv docs (GH-114658) (GH-114773)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 3911b42cc0)
2024-01-31 09:32:12 +00:00
Miss Islington (bot) 48632d22d6
[3.11] Docs: mark up dbm.gnu.open() and dbm.ndbm.open() using param list (GH-114762) (#114784)
(cherry picked from commit c8cf5d7d14)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-31 07:05:58 +00:00
Serhiy Storchaka 3dd3b301b6
[3.11] Fix more references to datetime and time classes (GH-114717) (GH-114726)
They could be confused with references to datetime and time modules.
(cherry picked from commit 39c766b579)
2024-01-29 16:59:59 +00:00
Serhiy Storchaka c67f94e385
[3.11] gh-101100: Fix datetime reference warnings (GH-114661) (GH-114718)
(cherry picked from commit e8b8f5e9c2)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-01-29 15:20:05 +00:00
Miss Islington (bot) 07d68ea843
[3.11] gh-89159: Add some TarFile attribute types (GH-114520) (GH-114715)
(cherry picked from commit d7d0d13cd3)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2024-01-29 14:25:52 +00:00
Miss Islington (bot) a2c55c56d3
[3.11] gh-110893: Improve the documentation for __future__ module (GH-114642) (#114703)
gh-110893: Improve the documentation for __future__ module (GH-114642)

nedbat took issue with the phrasing "real module". I'm actually fine
with that phrasing, but I do think the `__future__` page should be clear
about the way in which the `__future__` module is special. (Yes, there
was a footnote linking to the future statements part of the reference,
but there should be upfront discussion).

I'm sympathetic to nedbat's claim that no one really cares about
`__future__._Feature`, so I've moved the interesting table up to the
top.
(cherry picked from commit 3b86891fd6)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2024-01-29 09:46:04 +00:00
Miss Islington (bot) eff69a7bf9
[3.11] Correct Skip Montanaro's email address (GH-114677) (#114680)
Correct Skip Montanaro's email address (GH-114677)
(cherry picked from commit 5ecfd750b4)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-01-28 14:58:26 +00:00