Commit graph

27354 commits

Author SHA1 Message Date
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
Miss Islington (bot)
718dbd4cd3
[3.12] Normalize heading underline in multiprocessing.rst (GH-114923) (#114946)
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:26 +00:00
Miss Islington (bot)
9c6c40ec90
[3.12] gh-114913: Add newline to subprocess doc (GH-114941) (#114942)
*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:22 +00:00
Miss Islington (bot)
1eb873ef45
[3.12] Correct timedelta description (GH-101417) (GH-114938)
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:48:44 +00:00
Miss Islington (bot)
dee56434b5
[3.12] Fix indentation of "versionchanged" in datetime.rst (GH-114933) (GH-114937)
(cherry picked from commit b27812d632)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-02-02 23:18:07 +02:00
Miss Islington (bot)
e9d53248c6
[3.12] gh-114728: Fix documentation for comparison of objects in datetime module (GH-114749) (GH-114928)
(cherry picked from commit c12240ed28)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-02-02 19:01:34 +00:00
Miss Islington (bot)
e2f7aab9a9
[3.12] gh-103360: Add link in stdtypes.rst to escape sequences in lexical_analysis.rst (GH-103638) (GH-114907)
(cherry picked from commit d29f57f603)

Co-authored-by: Justin Williams <97240811+juswil@users.noreply.github.com>
2024-02-02 13:38:58 +00:00
Miss Islington (bot)
8cb7e5cc7c
[3.12] Move "format" param doc of shutil.make_archive() on its own paragraph (GH-103829) (GH-114897)
(cherry picked from commit 53339a0ef7)

Co-authored-by: Michal Kaptur <kaptur.michal@gmail.com>
2024-02-02 12:28:32 +02:00
Hugo van Kemenade
cc5870a1d7
[3.12] gh-101100: Fix sphinx warnings in howto/logging.rst (GH-114846) (#114878)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-02-01 20:45:51 +00:00
Miss Islington (bot)
8dcf4fbbad
[3.12] gh-89891: Refer SharedMemory implementation as POSIX (GH-104678) (GH-114873)
It only uses POSIX API.
(cherry picked from commit 500ede0117)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2024-02-01 22:35:43 +02:00
Miss Islington (bot)
1bb64e52ea
[3.12] Correct description of inheriting from another class (GH-114660) (#114868)
"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:11 +00:00
Miss Islington (bot)
a8a1df05f7
[3.12] gh-105031: Clarify datetime documentation for ISO8601 (GH-105049) (GH-114866)
(cherry picked from commit e9dab65638)

Co-authored-by: Nicholas Hollander <31573882+nhhollander@users.noreply.github.com>
2024-02-01 19:34:08 +02:00
Miss Islington (bot)
600724d442
[3.12] Fix typos in ElementTree documentation (GH-108848) (GH-114854)
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:41:01 +00:00
Miss Islington (bot)
09b8b14e05
[3.12] gh-114648: Add IndexError exception to tutorial datastructures list.pop entry (GH-114681) (#114841)
Remove redundant explanation of optional argument.
(cherry picked from commit 57c3e775df)

Co-authored-by: srinivasan <shivnaren@gmail.com>
2024-02-01 03:52:58 +00:00
Miss Islington (bot)
c26decab6f
[3.12] gh-67230: Add versionadded notes for QUOTE_NOTNULL and QUOTE_STRINGS (GH-114816) (#114840)
As @GPHemsley pointed out, GH-29469 omitted `versionadded` notes for the 2 new items.
(cherry picked from commit 586057e9f8)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
2024-02-01 03:17:56 +00:00
Miss Islington (bot)
3017c27d35
[3.12] gh-114811: Change '\*' to '*' in warnings.rst (GH-114819) (#114837)
Regression in 3.12.
(cherry picked from commit ff8939e5ab)

Co-authored-by: Pradyot Ranjan <99216956+prady0t@users.noreply.github.com>
2024-02-01 01:54:25 +00:00
Miss Islington (bot)
21b68a1198
[3.12] gh-111112: Avoid potential confusion in TCP server example. (GH-111113) (#114831)
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:34 +00:00
Miss Islington (bot)
c8e4c32105
[3.12] Add note to sys.orig_argv clarifying the difference from sys.argv (GH-114630) (#114821)
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:11 +00:00
Miss Islington (bot)
0536bbb192
[3.12] gh-101100: Fix class reference in library/test.rst (GH-114769) (GH-114794)
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:10 +00:00
Skip Montanaro
bb578f6286
[3.12] gh-101100: Fix references in csv docs (GH-114658) (GH-114771)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
(cherry picked from commit 3911b42cc0)
2024-01-31 09:32:25 +00:00
Miss Islington (bot)
fe5094c65f
[3.12] Docs: mark up dbm.gnu.open() and dbm.ndbm.open() using param list (GH-114762) (#114783)
(cherry picked from commit c8cf5d7d14)

Co-authored-by: Erlend E. Aasland <erlend@python.org>
2024-01-31 07:06:13 +00:00
Miss Islington (bot)
b3d01fc56d
[3.12] Clarify one-item tuple (GH-114745) (#114757)
A 'single tuple' means 'one tuple, of whatever length.
Remove the unneeded and slightly distracting parenthetical 'singleton' comment.
(cherry picked from commit a1332a99cf)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2024-01-30 18:50:28 +00:00
Miss Islington (bot)
424df31f00
[3.12] Set hosted_on for Read the Docs builds (GH-114697) (#114734)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-01-29 21:30:22 +00:00
Serhiy Storchaka
eed05e271c
[3.12] Fix more references to datetime and time classes (GH-114717) (GH-114725)
They could be confused with references to datetime and time modules.
(cherry picked from commit 39c766b579)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-29 17:01:24 +00:00
Miss Islington (bot)
783339a086
[3.12] gh-101100: Fix datetime reference warnings (GH-114661) (GH-114716)
(cherry picked from commit e8b8f5e9c2)

Co-authored-by: Skip Montanaro <skip.montanaro@gmail.com>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-01-29 17:12:03 +02:00
Miss Islington (bot)
0795d9a17a
[3.12] gh-89159: Add some TarFile attribute types (GH-114520) (GH-114714)
(cherry picked from commit d7d0d13cd3)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2024-01-29 14:25:46 +00:00
Miss Islington (bot)
c09a01032d
[3.12] gh-101100: Fix Sphinx warnings in whatsnew/2.2.rst (GH-112366) (#114711)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2024-01-29 13:18:34 +00:00
Miss Islington (bot)
930f805e72
[3.12] gh-101100: Fix sphinx warnings in Doc/c-api/memoryview.rst (GH-114669) (GH-114704)
(cherry picked from commit 97fb2480e4)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-01-29 10:02:06 +00:00
Miss Islington (bot)
d14003adf2
[3.12] gh-110893: Improve the documentation for __future__ module (GH-114642) (#114702)
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:48 +00:00