Commit graph

28157 commits

Author SHA1 Message Date
Miss Islington (bot)
cc8586a1ed
[3.13] Clarify base64.a85encode docs: *wrapcols* doesn't count the newline (GH-119409) (GH-119483)
Clarify base64.a85encode docs: *wrapcols* doesn't count the newline (GH-119409)
(cherry picked from commit ffa24aab10)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2024-05-28 16:55:37 +02:00
Miss Islington (bot)
47fb0f82cd
[3.13] [doc] Clarify the nature of the root logger in the logging documentation (GH-119440) (GH-119651)
(cherry picked from commit b407ad38fb)
2024-05-28 15:04:46 +01:00
Miss Islington (bot)
7322ff1561
[3.13] gh-119317: findall instead of traverse for docutils nodes (GH-119319) (#119486)
gh-119317: findall instead of traverse for docutils nodes (GH-119319)
(cherry picked from commit 0867bce457)

Co-authored-by: Carlos Meza <hire@carlosmeza.com>
2024-05-27 23:46:15 +00:00
Hugo van Kemenade
0a4a3184f5
[3.13] Docs: Move inline JavaScript to own file to reduce duplication (GH-119541) (#119630) 2024-05-27 12:49:52 -06:00
Miss Islington (bot)
8117cb5f01
[3.13] Misc cleanups and wording improvements for the itertools docs (gh-119626) (gh-119629) 2024-05-27 13:44:11 -05:00
Miss Islington (bot)
9edf0109eb
[3.13] gh-119580: Improve version added section for convenience variable (GH-119583) (#119624)
Co-authored-by: Tian Gao <gaogaotiantian@hotmail.com>
2024-05-27 18:13:01 +00:00
Miss Islington (bot)
ba71835fa5
[3.13] Docs: Only install sphinx-autobuild for make htmllive (GH-119607) (#119621)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-05-27 17:44:55 +00:00
Miss Islington (bot)
f1302c1e47
[3.13] gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475) (#119602)
gh-119467: Fix Py_buffer.format type and correct documentation typo (GH-119475)
(cherry picked from commit 3b26cd8ca0)

Co-authored-by: Aditya Borikar <adityaborikar2@gmail.com>
2024-05-27 12:34:13 +00:00
Miss Islington (bot)
3f0198d927
[3.13] docs: fix a few typos identified by codespell (GH-119516) (#119570)
Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2024-05-26 08:20:37 +00:00
Miss Islington (bot)
317cc3bcd2
[3.13] FAQ: Add reference to Python version numbering scheme (GH-119225) (#119544)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-05-25 14:29:47 +00:00
Miss Islington (bot)
f49749cf8f
[3.13] gh-111999: Fix the signature of str.format_map() (GH-119540) (#119543)
(cherry picked from commit 08e65430aa)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-05-25 13:46:41 +00:00
Raymond Hettinger
5544651350
[3.13] Misc improvement to the docs for itertools (gh-119529) (#119531)
Misc improvement to the docs for itertools (gh-119529)
2024-05-24 17:26:25 -05:00
Miss Islington (bot)
392a3d8ade
[3.13] Regen `Doc/requirements-oldest-sphinx.txt` (GH-119520) (#119522)
Co-authored-by: Kirill Podoprigora <kirill.bast9@mail.ru>
2024-05-24 14:01:44 -06:00
Miss Islington (bot)
c864efba25
[3.13] gh-118692: Avoid creating unnecessary StopIteration instances for monitoring (GH-119216) (#119497)
* gh-118692: Avoid creating unnecessary StopIteration instances for monitoring (GH-119216)
(cherry picked from commit 6e9863d7a3)

---------

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2024-05-24 10:18:13 +00:00
Miss Islington (bot)
89e2689545
[3.13] gh-90562: Mention slots pitfall in dataclass docs (GH-107391) (#119350)
Co-authored-by: Josh Cannon <joshdcannon@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Erlend E. Aasland <erlend@python.org>
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
2024-05-23 00:16:19 -06:00
Miss Islington (bot)
a6ed7425d8
[3.13] gh-70795: Rework RLock documentation (GH-103853) (#119436)
gh-70795: Rework RLock documentation (GH-103853)

Attempted to simultaneously reduce verbosity, while more descriptively
describing behavior.

Fix links (RLock acquire/release previously linking to Lock
acquire/release, seems like bad copy pasta).

Add a seealso for with-locks.

Switch section to use bullet points.

---------

(cherry picked from commit 2fbea81d64)

Co-authored-by: uıɐɾ ʞ ʇɐɯɐs <_@skj.io>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: C.A.M. Gerlach <CAM.Gerlach@Gerlach.CAM>
2024-05-22 14:21:58 -07:00
Miss Islington (bot)
0bd7c879cf
[3.13] gh-112066: Fix versionadded in PyDict_SetDefaultRef docs (GH-118696) (#119430)
(cherry picked from commit 447edb6e98)

Co-authored-by: Lysandros Nikolaou <lisandrosnik@gmail.com>
2024-05-22 15:36:35 -04:00
Miss Islington (bot)
414346e56d
[3.13] Fix version number in use_load_tests deprecation reference (GH-119151) (GH-119386)
Deprecation took place in d78742a260 (3.5)
(cherry picked from commit aee8f03abb)

Co-authored-by: Jacob Walls <jacobtylerwalls@gmail.com>
2024-05-22 09:58:59 +00:00
Miss Islington (bot)
f757996942
[3.13] Clarify that dklen is expected in bytes for the hashlib functions (GH-106624) (GH-119383)
(cherry picked from commit 5adf78f546)

Co-authored-by: Mathijs Mortimer <thiezn@users.noreply.github.com>
2024-05-22 09:10:02 +00:00
Miss Islington (bot)
b5b0e3210d
[3.13] DOCS: fix error in exec namespace note (gh-119380)
When updating the new exec note added in gh-119235 as part of the
PEP 667 general docs PR, I suggested a workaround that isn't valid.

The first half of the note is still reasonable, so just omit the invalid text.

(cherry picked from commit 31d61a75c9)

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
2024-05-22 06:58:36 +00:00
Miss Islington (bot)
455b386234
[3.13] gh-110383: Align dict.get(), .fromkeys(), and .setdefault() docs with docstrings (GH-119330) (#119370)
(cherry picked from commit 0e3c8cda1f)

Co-authored-by: Landon Wood <landon@elkrange.com>
2024-05-22 01:31:56 +00:00
Miss Islington (bot)
05820164ce
[3.13] Docs: Add central references to free-threading-related options (GH-119017) (#119367)
Docs: Add central references to free-threading-related options (GH-119017)
(cherry picked from commit 9fa206aaec)

Co-authored-by: Brett Simmers <swtaarrs@users.noreply.github.com>
2024-05-21 23:16:59 +00:00
Miss Islington (bot)
256b791fd6
[3.13] gh-110383: Document socket.makefile() accepts combined modes (GH-119150) (#119324)
The supported mode values are 'r', 'w', and 'b', or a combination of those.
(cherry picked from commit 62a29be5bb)

Co-authored-by: Daniel Williams <dann0a@gmail.com>
2024-05-21 18:44:53 +00:00
Miss Islington (bot)
11ca1d9d53
[3.13] GH-110383: Improve Tutorial for Input Ouput (GH-119230) (GH-119326)
GH-110383: Improve Tutorial for Input Ouput (GH-119230)

(cherry picked from commit 9db2fd7eda)

Co-authored-by: Blaise Pabon <blaise@gmail.com>
Co-authored-by: edson duarte <eduarte.uatach@gmail.com>
2024-05-21 19:54:26 +02:00
Hugo van Kemenade
1929b7e2bf
[3.13] Docs: Ensure no warnings are found in the NEWS file before a given line number (GH-119221) (#119261) 2024-05-21 08:40:08 -06:00
Miss Islington (bot)
db64dae745
[3.13] gh-74929: PEP 667 general docs update (gh-119291)
* expand on What's New entry for PEP 667 (including porting notes)
* define 'optimized scope' as a glossary term
* cover comprehensions and generator expressions in locals() docs
* review all mentions of "locals" in documentation (updating if needed)
* review all mentions of "f_locals" in documentation (updating if needed)

(cherry picked from commit e870c852c0)

Co-authored-by: Alyssa Coghlan <ncoghlan@gmail.com>
2024-05-21 21:35:26 +10:00
Miss Islington (bot)
24b0e8ddb4
[3.13] gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232) (#119284)
gh-118912: Remove description of issue fixed in 3.5 from autospeccing guide (GH-119232)

* Remove description of issue fixed in 3.5 from autospeccing guide

* Make autospeccing note text more succint and lint whitespace

* Add linting changes (missed in last commit)

---------

(cherry picked from commit 7e57640c7e)

Co-authored-by: Shauna <shaunagm@gmail.com>
Co-authored-by: Carol Willing <carolcode@willingconsulting.com>
2024-05-20 23:50:23 +00:00
Miss Islington (bot)
d8fbe5b64a
[3.13] gh-108267 Fix another dataclasses docs typo (GH-119277) (#119279)
gh-108267 Fix another dataclasses docs typo (GH-119277)
(cherry picked from commit 423bbcbbc4)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-05-20 22:53:32 +00:00
Miss Islington (bot)
b4462aaed6
[3.13] gh-118760: Restore the default value of tkinter.wantobjects to 1 (GH-118784) (GH-119251)
It was set to 2 in 65f5e586a1 (GH-98592).
(cherry picked from commit e188527c34)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2024-05-20 20:28:42 +00:00
Miss Islington (bot)
906f6cb656
[3.13] Use correct markup in unittest.mock.reset_mock documentation (GH-119207) (GH-119250)
Use correct markup in unittest.mock.reset_mock documentation (GH-119207)
(cherry picked from commit 6b80a5b20f)

Co-authored-by: Tialo <65392801+Tialo@users.noreply.github.com>
2024-05-20 22:12:38 +02:00
Miss Islington (bot)
fda3291643
[3.13] DOCS: Suggest always calling exec with a globals argument and no locals argument (GH-119235) (#119239)
DOCS: Suggest always calling exec with a globals argument and no locals argument (GH-119235)

Many users think they want a locals argument for various reasons but they do not
understand that it makes code be treated as a class definition. They do not want
their code treated as a class definition and get surprised. The reason not
to pass locals specifically is that the following code raises a `NameError`:

```py
exec("""
def f():
    print("hi")

f()

def g():
    f()
g()
""", {}, {})
```

The reason not to leave out globals is as follows:

```py
def t():
    exec("""
def f():
    print("hi")

f()

def g():
    f()
g()
    """)
```
(cherry picked from commit 7e1a130b8f)

Co-authored-by: Hood Chatham <roberthoodchatham@gmail.com>
2024-05-20 18:15:25 +00:00
Miss Islington (bot)
8f3fc01c4c
[3.13] [docs] TypeVarTuple default is keyword-only (GH-119215) (#119224)
(cherry picked from commit e406b399f9)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2024-05-20 15:57:19 +00:00
Miss Islington (bot)
cbf064b096
[3.13] typing docs: Fix formatting issue (GH-119210) (#119212)
typing docs: Fix formatting issue (GH-119210)
(cherry picked from commit 72d07dd30b)

Co-authored-by: David Foster <david@dafoster.net>
2024-05-20 15:08:49 +00:00
Miss Islington (bot)
bc5e47ccb7
[3.13] marshal docs: Remove reference to "Sun" (GH-119161) (#119167)
Nobody has been using a Sun machine for a long time. When I saw
this sentence in a lightning talk just now, I thought it was talking
about sending Python code on a spacecraft.
(cherry picked from commit 697465ff88)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-05-19 02:33:04 +00:00
Miss Islington (bot)
641e59db59
[3.13] docs: make mimalloc license text literal (GH-119046) (#119149)
docs: make mimalloc license text literal (GH-119046)
(cherry picked from commit 691429702f)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-05-18 16:40:07 +00:00
Miss Islington (bot)
1bb3a9df1b
[3.13] gh-119078: Clarify venv tutorial (GH-119129) (GH-119142)
(cherry picked from commit 0f5e8bed63)
2024-05-18 13:06:23 +01:00
Miss Islington (bot)
374655fa83
[3.13] Minor improvements to the docs for itertools.tee() (gh-119135) (gh-119136) 2024-05-18 01:51:04 -05:00
Miss Islington (bot)
c69fe804b6
[3.13] gh-108267: Fix object.__setattr__ regression in dataclasses docs (GH-119082) (#119097)
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2024-05-16 13:56:42 +00:00
Miss Islington (bot)
bca7fb0e7a
[3.13] Use literal syntax in origin property (GH-119029) (#119083)
Use literal syntax in origin property (GH-119029)
(cherry picked from commit 66b73e9724)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-05-16 05:30:33 +00:00
Miss Islington (bot)
7c224dd4cc
[3.13] gh-119009: Add gettext target (GH-119006) (#119074)
Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2024-05-15 18:31:55 +00:00
Miss Islington (bot)
dd8a61f901
[3.13] 3.13 What's New: Add PEP 702 (GH-118922) (#119062)
I honestly forgot this slipped into 3.13, but I think it's worth highlighting more, as it is a PEP-sized change that makes the type system significantly more powerful.

@Yhg1s I think it's also worth mentioning in your release announcements.
(cherry picked from commit ee13797dec)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-05-15 02:56:37 +00:00
Miss Islington (bot)
8439d09aa1
[3.13] Misc improvements to the itertools docs (gh-119040) (#119045) 2024-05-14 15:38:53 +00:00
Miss Islington (bot)
87f683e09a
[3.13] Itertools docs: fix parameter names and indentation in Python equivalents (gh-118977) (#119043) 2024-05-14 15:11:31 +00:00
Miss Islington (bot)
d1aac22b7a
[3.13] gh-119010: Adds docs about __type_params__ to functools.update_wrapper (GH-119012) (#119013)
gh-119010: Adds docs about `__type_params__` to `functools.update_wrapper` (GH-119012)
(cherry picked from commit b04c497f18)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2024-05-13 20:19:10 +00:00
Miss Islington (bot)
941883208c
[3.13] Improve the rmtree doc for dir_fd param addition in 3.11 (GH-118964) (#118991)
Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2024-05-13 11:21:10 +00:00
Miss Islington (bot)
0874a400a8
[3.13] Correct the argument names for secrets.choice and secrets.randbelow in secrets.rst (GH-118098) (GH-118906)
Correct the argument names for `secrets.choice` and `secrets.randbelow` in `secrets.rst` (GH-118098)

Correct the argument names for `secrets.choice` and `secrets.randbelow` in `secrets.rst`.
(cherry picked from commit c444362c6e)

Co-authored-by: Adam Dangoor <adamdangoor@gmail.com>
2024-05-10 14:56:33 +00:00
Miss Islington (bot)
7dc9875d55
gh-118209: Add Windows structured exception handling to mmap module (GH-118213)
(cherry picked from commit e85e8deaf3)

Co-authored-by: Dobatymo <Dobatymo@users.noreply.github.com>
2024-05-10 12:00:00 +01:00
Miss Islington (bot)
760b3f08dc
gh-118689: Doc: fix ePub build (GH-118690)
(cherry picked from commit 7ac933e260)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2024-05-10 10:40:35 +00:00
Miss Islington (bot)
00ec116883
[3.13] gh-118851: Default ctx arguments to AST constructors to Load() (GH-118854) (#118871)
(cherry picked from commit 68fbc00dc8)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2024-05-09 22:52:42 +00:00
Steve Dower
d86b494117
gh-118486: Update docs for CVE-2024-4030 reference (GH-118737)
Update docs for CVE-2024-4030 reference
2024-05-09 12:52:11 +01:00