Commit graph

12437 commits

Author SHA1 Message Date
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
Miss Islington (bot)
8884a21417
[3.11] gh-101100: Fix sphinx warnings in library/email.mime.rst (GH-114635) (GH-114641)
(cherry picked from commit 6a8944acb6)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-27 08:52:57 +00:00
Miss Islington (bot)
dfef41a1d6
[3.11] Docs: rework the dbm.dumb introduction (GH-114550) (#114621)
(cherry picked from commit 6c2b419fb9)

- consistently use correct parameter markup
- consistently use submodule name as database name
- improve accuracy of the dbm.dumb.open() spec
- remove dumbdbm class refs and replace them with generic "database object"
- use parameter list for dbm.dumb.open()
(cherry picked from commit 6c2b419fb9)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 18:19:55 +00:00
Miss Islington (bot)
c4a616352d
[3.11] Docs: mark up dbm.open() with param list (GH-114601) (#114605)
Also consolidate following paragraphs regarding database objects.

(cherry picked from commit 0bd8297a22)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 15:18:50 +00:00
Erlend E. Aasland
89015c528c
[3.11] Docs: reword dbm.ndbm introduction (#114549) (#114600)
(cherry picked from commit 4cf068ed08)

- add abbreviation directives for NDBM and GDBM
- consistently spell NDBM as NDBM
- silence broken ndbm class refs
- improve accuracy of dbm.ndbm.open() spec
- use replacement text for NDBM/GDBM file format incompatibility note
2024-01-26 13:56:52 +01:00
Miss Islington (bot)
7792d5af15
[3.11] Docs: fix versionchanged directives for dbm.open() and dbm.whichdb() (GH-114594) (#114596)
(cherry picked from commit 8710faeac2)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 12:43:22 +00:00
Miss Islington (bot)
87958e6aa3
[3.11] Docs: rework dbm introduction (GH-114551) (#114591)
- add refs to other parts of the docs (dict, bytes, etc.)
- clarify whichdb() return value by using list markup
- silence refs to example or generic submodule methods (keys, get, etc.)

(cherry picked from commit 65cf5dce11)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-26 10:24:05 +00:00
Erlend E. Aasland
938c7f716d
[3.11] Docs: reword dbm.gnu introduction (#114548) (#114589)
(cherry picked from commit 06c5de36f2)

Also...
- consistently spell GDBM as GDBM
- silence gdbm class refs
- improve accuracy of dbm.gdbm.open() spec
2024-01-26 10:15:34 +00:00
Miss Islington (bot)
d7d3690af7
[3.11] gh-108731: Add description of __slots__ to MemberDescriptorType docs (GH-108745) (GH-114537)
(cherry picked from commit 6888cccac0)

Co-authored-by: plokmijnuhby <39633434+plokmijnuhby@users.noreply.github.com>
2024-01-24 20:05:12 +00:00
Miss Islington (bot)
94c5567e91
[3.11] Docs: mark up the FTP_TLS() docs with param list (GH-114510) (#114533)
Also turn sentence about prot_p() into a note.

(cherry picked from commit 6fadd68da5)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-24 17:28:55 +01:00
Hugo van Kemenade
aa17d917e1
[3.11] gh-101100: Fix sphinx warnings in concurrent.futures.rst (GH-114521) (#114526)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-24 13:46:13 +00:00
Miss Islington (bot)
208db89fe6
[3.11] gh-101100: Fix sphinx warnings in asyncio-task.rst (GH-114469) (#114518)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-24 00:32:00 -07:00
Miss Islington (bot)
018b637a52
[3.11] Fix a typo in the contextlib documentation (GH-114507) (#114515) 2024-01-24 04:22:38 +00:00
Miss Islington (bot)
e85f4c6fa9
[3.11] Docs: use placeholders in dbm flag param docs (GH-114482) (#114498)
Also correct the default flag param for dbm.dumb.open();
it's 'c', not 'r'.
(cherry picked from commit 8c265408c5)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-23 21:05:39 +01:00
Miss Islington (bot)
8790e5799a
[3.11] Docs: mark up FTP.connect() and FTP.login() with param lists (GH-114395) (#114486)
Use rst substitutions to reduce raw text duplication.

(cherry picked from commit 01105c7c4f)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-23 14:03:51 +00:00
Miss Islington (bot)
ec71690fcc
[3.11] Docs: mark up FTP.retrbinary and FTP.storbinary with param lists (GH-114399) (#114484)
(cherry picked from commit 5277d4c7db)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 14:00:35 +00:00
Miss Islington (bot)
b62db465e5
[3.11] gh-101100: Fix sphinx warnings in Doc/library/locale.rst (GH-114425) (#114478)
gh-101100: Fix sphinx warnings in `Doc/library/locale.rst` (GH-114425)

* gh-101100: Fix sphinx warnings in `Doc/library/locale.rst`

* Remove `/` from signatures
(cherry picked from commit 7d21cae964)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-23 13:24:51 +02:00
Erlend E. Aasland
eb94a0426f
[3.11] Docs: align usage of versionadded/versionchanged with recommended practice (#114409) (#114473)
(cherry picked from commit 1d7bddd961)

Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2024-01-23 10:39:25 +01:00
Miss Islington (bot)
1f04ac8e27
[3.11] GH-105900: Fix pathlib.Path.symlink_to(target_is_directory=...) docs (GH-114035) (#114465)
Clarify that *target_is_directory* only matters if the target doesn't
exist.
(cherry picked from commit b822b85ac1)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
2024-01-23 05:37:32 +00:00
Miss Islington (bot)
9d2ad6f24a
[3.11] GH-82695: Clarify pathlib.Path.mkdir() documentation (GH-114032) (#114463)
Remove a double negative in the documentation of `mkdir()`'s *exist_ok*
parameter.

(cherry picked from commit 32c227470a)

Co-authored-by: Barney Gale <barney.gale@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2024-01-23 02:37:55 +00:00
Barney Gale
20f3669ac2
[3.11] GH-99334: Explain that PurePath.is_relative_to() is purely lexical. (GH-114031) (#114461)
(cherry picked from commit 3a61d24062)
2024-01-23 01:16:21 +00:00
Miss Islington (bot)
dcda3aaa6a
[3.11] gh-66944: Note that the contextlib.closing example is for illustrative purposes (GH-112198) (#114459) 2024-01-23 01:07:14 +00:00
Serhiy Storchaka
459726f6cd
[3.11] gh-114115: Update documentation of array.array (GH-114117) (GH-114418)
(cherry picked from commit 650f9e4c94)

Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-22 09:37:09 +00:00
Erlend E. Aasland
9f164ab70b
[3.11] Docs: align sqlite3 docs with versionadded/versionchanged recommendations (#114400) (#114403)
(cherry picked from commit 336030161a)

When a parameter is added to a function or method, use the 'versionchanged'
directive, not 'versionadded'.
2024-01-21 20:07:46 +00:00
Miss Islington (bot)
a4587c1846
[3.11] Docs: link to sys.stdout in ftplib docs (GH-114396) (#114398)
(cherry picked from commit de17cf444a)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-21 17:47:48 +00:00