Commit graph

24764 commits

Author SHA1 Message Date
Erlend Egeberg Aasland
c4440e6bc0
[3.10] gh-93925: Improve clarity of sqlite3 commit/rollback, and close docs (GH-93926) (#94011)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 6446592c89)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-06-19 21:43:03 +02:00
Miss Islington (bot)
f21b071729
What's new in 3.10: fix link to issue (GH-93968)
* What's new in 3.10: fix link to issue

* What's new in 3.10: fix link to GH issue

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 59c1b33805)

Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2022-06-19 02:14:21 -07:00
Kumar Aditya
5163a25354
gh-91877: Fix WriteTransport.get_write_buffer_{limits,size} docs (#92338) (#93805)
- Amend docs for WriteTransport.get_write_buffer_limits
- Add docs for WriteTransport.get_write_buffer_size

Co-authored-by: Sanket Shanbhag <TechieBoy@users.noreply.github.com>
2022-06-16 18:19:17 +02:00
Miss Islington (bot)
e929dae42a
gh-93857: Fix broken audit-event targets in sqlite3 docs (GH-93859)
Corrected targets for the following audit-events:

- sqlite3.enable_load_extension => sqlite3.Connection.enable_load_extension
- sqlite3.load_extension => sqlite3.Connection.load_extension
(cherry picked from commit ce4d11f98b)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 07:24:50 -07:00
Miss Islington (bot)
5dee1d840c
gh-87260: Update sqlite3 signature docs to reflect actual implementation (GH-93840)
Align the docs for the following methods with the actual implementation:

- sqlite3.complete_statement()
- sqlite3.Connection.create_function()
- sqlite3.Connection.create_aggregate()
- sqlite3.Connection.set_progress_handler()
(cherry picked from commit d31834688b)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 03:46:33 -07:00
Erlend Egeberg Aasland
56ee410053
[3.10] gh-89018: Improve documentation of sqlite3 exceptions (GH-27645) (#93838)
- Order exceptions as in PEP 249
- Reword descriptions, so they match the current behaviour

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit bb0b768946)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 11:55:30 +02:00
Miss Islington (bot)
095d09c0a8
gh-93183: Adjust wording in socket docs (GH-93832)
package => packet

Co-authored-by: Victor Norman
(cherry picked from commit cdd3984307)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-15 01:51:28 -07:00
Miss Islington (bot)
58277de8e6
Change list to view object (GH-93661)
(cherry picked from commit 5d8e7a1240)

Co-authored-by: Pamela Fox <pamela.fox@gmail.com>
2022-06-11 04:13:38 -07:00
Miss Islington (bot)
9fafc0acf7
gh-91317: Document that Path does not collapse initial // (GH-32193)
Documentation for `pathlib` says:

> Spurious slashes and single dots are collapsed, but double dots ('..') are not, since this would change the meaning of a path in the face of symbolic links:

However, it omits that initial double slashes also aren't collapsed.

Later, in documentation of `PurePath.drive`, `PurePath.root`, and `PurePath.name` it mentions UNC but:

- this abbreviation says nothing to a person who is unaware about existence of UNC (Wikipedia doesn't help either by [giving a disambiguation page](https://en.wikipedia.org/wiki/UNC))
- it shows up only if a person needs to use a specific property or decides to fully learn what the module provides.

For context, see the BPO entry.
(cherry picked from commit 78f1a43694)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-10 16:10:29 -07:00
Miss Islington (bot)
a2695be91c
[3.10] Improve logging documentation with example and additional cookbook re… (GH-93644) (GH-93648)
(cherry picked from commit e974b3e333)

Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-06-10 16:31:00 +02:00
Miss Islington (bot)
5b2ad48431
gh-87961: Remove outdated notes from functions that aren't in the Limited API (GH-93581) (GH-93605)
Nowadays everything that *is* in the Limited API has a note added
automatically.
These notes could mislead people to think that these functions
could never be added to the limited API. Remove them.

(cherry picked from commit 2c3fe5eeb2)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2022-06-10 16:04:47 +02:00
Miss Islington (bot)
2139583bf9
Doc: Update references and examples of old, unsupported OSes and uarches (GH-92791) (GH-93639)
(cherry picked from commit a5ba0f4ebc)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-06-09 16:15:49 +02:00
jacksonriley
6b9122483f
[3.10] Fix PurePath.relative_to links in the pathlib documentation (GH-93268) (GH-93590)
These are currently broken as they refer to :meth:`Path.relative_to` rather than :meth:`PurePath.relative_to`, and `relative_to` is a method on `PurePath`..
(cherry picked from commit 8ef7929baf)

Co-authored-by: jacksonriley <52106215+jacksonriley@users.noreply.github.com>

Backport of #93268
2022-06-07 14:58:43 -07:00
Miss Islington (bot)
c7b5a2d5ea
gh-88831: In docs for asyncio.create_task, explain why strong references to tasks are needed (GH-93258) (GH-93567)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 75ceae05c1)

Co-authored-by: Andreas Grommek <76997441+agrommek@users.noreply.github.com>
2022-06-07 12:14:25 +02:00
Miss Islington (bot)
6b7b901ff2
gh-86986: bump min sphinx version to 3.2 (GH-93337) (GH-93562)
(cherry picked from commit 57e8ee7086)

Co-authored-by: Davide Rizzo <sorcio@gmail.com>
2022-06-07 10:24:54 +02:00
Miss Islington (bot)
386babebe9
gh-93391: fix typo in array docs (GH-93392) (GH-93395)
Fixes GH-93391

(cherry picked from commit fc694364cc)

Co-authored-by: ynfle <23086821+ynfle@users.noreply.github.com>
2022-06-06 19:14:04 +02:00
Miss Islington (bot)
ce057ae1e3
gh-93372: Fix typo in os.rename documentation (GH-93401) (GH-93404)
(cherry picked from commit e7aab7c92a)

Co-authored-by: Wei-Ting Yang <74453331+Yang-Wei-Ting@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-06-06 19:11:18 +02:00
Miss Islington (bot)
8dc8b27eb0
gh-83728: Add hmac.new default parameter deprecation (GH-91939) (GH-93545)
(cherry picked from commit 56b5daf159)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-06-06 19:10:15 +02:00
Julien Palard
632eef7b58
[3.10] gh-93108: Bump sphinx to fix rendering issue. (GH-93159)
Bug was visible on SysLogHandler:

bad: SysLogHandler(address='localhost', SYSLOG_UDP_PORT, ...
good: SysLogHandler(address=('localhost', SYSLOG_UDP_PORT), ...
2022-06-06 18:59:22 +02:00
Miss Islington (bot)
3d19051386
📝 Make sure the phrase "constant-time compare" actually appears in the docs (GH-93396) (#93400)
This is purely for SEO as this is the actual generic name for this kind of method and it currently does not appear in a Google search for "python constant time compare". Not creating an issue or setting this up for backports as its trivial (I think) and not a functional change.
(cherry picked from commit 8241a6971e)

Co-authored-by: Noah Kantrowitz <noah@coderanger.net>
2022-06-06 18:54:04 +02:00
Miss Islington (bot)
0b7aae88d0
Remove the execution bit to some socket-related files. (GH-93368)
(cherry picked from commit 5247389369)

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
2022-06-01 00:31:31 -07:00
Miss Islington (bot)
694455d5ed
Remove VOC reference (93333)
VOC has been archived by the BeeWare project, and they are instead
embedding CPython, rather than transpiling to Java bytecode.
(cherry picked from commit bb900712a5)

Co-authored-by: Carl Bordum Hansen <carl@bordum.dk>
2022-05-31 10:49:14 -07:00
Miss Islington (bot)
aa06a84099
bpo-42272: fix misleading warning filter message/module docs (GH-23172)
* bpo-42272: improve message/module warning filter docs

"The Warnings Filter" section of the warnings module documentation
describes the message and module filters as "a string containing a
regular expression".  While that is true when they are arguments to the
filterwarnings function, it is not true when they appear in -W or
$PYTHONWARNINGS where they are matched literally (after stripping any
starting/ending whitespace).  Update the documentation to note when they
are matched literally.  Also clarify that module matches the
"fully-qualified module name", rather than "module name" which is
ambiguous.

skip news (since this is a doc fix)

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

* bpo-42272: remove bad submodule warning filter doc

The `error:::mymodule[.*]` example in the "Describing Warning Filters"
section of the warnings module documentation does not behave as the
comment describes.  Since the module portion of the filter string is
interpreted literally, it would match a module with a fully-qualified
name that is literally `mymodule[.*]`.

Unfortunately, there is not a way to match '"module" and any subpackages
of "mymodule"' as documented, since the module part of a filter string
is matched literally.  Instead, update the filter and comment to match
only "mymodule".

skip news (since this is a doc fix)

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>

* bpo-42272: add warning filter doc changes to NEWS

Signed-off-by: Kevin Locke <kevin@kevinlocke.name>
(cherry picked from commit 8136606769)

Co-authored-by: Kevin Locke <kevin@kevinlocke.name>
2022-05-29 19:03:15 -07:00
Miss Islington (bot)
738c730b5c
gh-92240 : Include release dates for "What's New In Python 3.X" (GH-92937)
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
(cherry picked from commit 877ad7b3b2)

Co-authored-by: georgically <40323509+georgically@users.noreply.github.com>
2022-05-28 20:41:40 -07:00
Miss Islington (bot)
9912b3d989
gh-77024: test.support: Improve documentation (GH-92513)
This is a rework of GH-5774 on current main. I was a bit more
conservative in making changes than the original PR.

See @csabella's comments on issue GH-77024 and the discussion
on GH-5774 for explanations of several of the changes.

Co-authored-by: Cheryl Sabella <cheryl.sabella@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 8995177030)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-27 12:25:21 -07:00
Miss Islington (bot)
251104f12d
[3.10] gh-92859: Doc: add info about logging.debug() calling basicConfig() (GH-93063) (GH-93150) 2022-05-23 20:45:44 +01:00
Miss Islington (bot)
c8f1095e0a
gh-89158: Add some REPL secondary prompt markers (GH-93073)
This fixes an issue on tutorial/classes.rst section 9.4 where the example "class Warehouse"
was truncated when pressing the >>> button to hide the prompts and output.
(cherry picked from commit 88f0d0c1e8)

Co-authored-by: Nicolas Haller <nicolas@haller.im>
2022-05-22 22:17:15 -07:00
Miss Islington (bot)
936eefcb82
gh-92994: Clarify importlib "check" example (GH-92995)
Fixes GH-92994
(cherry picked from commit e39cd76561)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-05-22 19:11:58 -07:00
Miss Islington (bot)
619a67cc06
gh-73137: Added sub-subsection headers for flags in re (GH-93000)
Fixes GH-73137
(cherry picked from commit b7a6610bc8)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-05-22 19:06:54 -07:00
Miss Islington (bot)
54b5e4da8a
gh-91362: reword pickle docs to account for nested classes (GH-92429)
Fixes GH-91362
(cherry picked from commit f9d6c59917)

Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2022-05-21 08:10:56 -07:00
Miss Islington (bot)
3c2a1e7f4a
[3.10] gh-72073: Add Windows case in pathlib.rename (GH-93002) (GH-93029)
GH-72073

https://docs.python.org/3.12/library/pathlib.htmlGH-pathlib.Path.rename
(cherry picked from commit f51ed04c66)


Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>

Automerge-Triggered-By: GH:brettcannon
2022-05-20 15:44:07 -07:00
Miss Islington (bot)
4d363d8989
Doc: add missing manpage and title references in tkinter docs (GH-29008)
- add bind(3tk) manpage markup
- add Tcl/Tk book reference markup
(cherry picked from commit 0e12781ad9)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2022-05-20 02:21:29 -07:00
Miss Islington (bot)
5d7f3dc3dc
bpo-46879: Fix incorrect sphinx object names in doc (GH-31615) (GH-92975)
(cherry picked from commit 2cdd57f119)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
Co-authored-by: Martin Fischer <martin@push-f.com>
2022-05-19 17:57:46 +02:00
Miss Islington (bot)
3d47035686
gh-92417: subprocess docs: remove note on compatibility with Python <3.5 (GH-92538) (GH-92973)
(cherry picked from commit 84b86000e2)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-19 17:49:13 +02:00
Miss Islington (bot)
93ebac7a79
gh-92417: fractions, decimal: Improve docs for alternative constructor methods (GH-92421) (GH-92971)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 090df844ea)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-19 17:45:30 +02:00
Miss Islington (bot)
ebf3f12c38
gh-92417: socket docs: remove references to Python <3.3 (GH-92544) (GH-92969)
(cherry picked from commit 639b62c9c4)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2022-05-19 17:44:31 +02:00
Miss Islington (bot)
fb566cacb3
bpo-45393: help() on operator precedence has misleading entries (GH-31246) (GH-92966)
(cherry picked from commit fb082c2fc5)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2022-05-19 17:32:54 +02:00
Miss Islington (bot)
4e289e20e2
gh-92417: Update docs and examples of doctest.IGNORE_EXCEPTION_DETAIL for Py>=3 (GH-92502) (GH-92963)
(cherry picked from commit 97b9c1096f)
2022-05-19 17:19:53 +02:00
Miss Islington (bot)
3e534b464a
Doc: amend ssl.PROTOCOL_SSLv2 and ssl.PROTOCOL_SSLv3 wording (GH-92634)
(cherry picked from commit 41638967a0)

Co-authored-by: Jan Brasna <1784648+janbrasna@users.noreply.github.com>
2022-05-19 02:40:39 -07:00
Miss Islington (bot)
17524b084b
gh-92812: Align ArgumentParser.add_subparsers() docs with argument spec (GH-92814)
(cherry picked from commit f2d994da10)

Co-authored-by: 180909 <734461790@qq.com>
2022-05-18 14:30:00 -07:00
Miss Islington (bot)
ed75d2183f
bpo-40838: document getdoc, getmodule, getsourcefile in inspect returns None (GH-30575)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit b86d783a4e)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2022-05-18 05:49:15 -07:00
Miss Islington (bot)
94e21cf229
gh-92780: Improve sqlite3.Connection.create_collation docs (GH-92790)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
(cherry picked from commit 7ee19e2715)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-05-18 05:05:24 -07:00
Miss Islington (bot)
1815d8e64f
gh-91755: Document Py_IncRef and Py_DecRef as C functions (GH-91805)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
(cherry picked from commit 58a3d28039)

Co-authored-by: Charlie Zhao <zhaoyu_hit@qq.com>
2022-05-18 02:00:00 -07:00
Miss Islington (bot)
006b302beb
gh-80143: Add clarification for escape characters (GH-92292) (GH-92629)
(cherry picked from commit 549567c6e7)

Co-authored-by: slateny <46876382+slateny@users.noreply.github.com>
2022-05-16 18:54:40 +02:00
Hugo van Kemenade
cfb9248cd4
Speedup: build docs in parallel (GH-92733) (GH-92850)
(cherry picked from commit a487623c6b)
2022-05-16 18:53:38 +02:00
Miss Islington (bot)
93d9b782cc
gh-87670: Add web.archive redirects from effbot (GH-92816)
(cherry picked from commit 3ed1cae9ed)

Co-authored-by: Stanley <46876382+slateny@users.noreply.github.com>
2022-05-15 23:27:54 -07:00
thueringa
56e9fb3e3b
Fix typo in argparse docs. (GH-92691) (#92729) 2022-05-13 16:09:06 -05:00
Miss Islington (bot)
597ff24188
gh-92611: Link to PEP 594 sections & add key detail in doc deprecation notices (GH-92612)
(cherry picked from commit 9f68dab3d3)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-05-13 13:11:05 -07:00
Miss Islington (bot)
48f2d8de24
Document Py_ssize_t. (GH-92512)
It fixes 252 errors from a Sphinx nitpicky run (sphinx-build -n). But
there's 8182 errors left.

Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit 664aa94b57)

Co-authored-by: Julien Palard <julien@palard.fr>
2022-05-13 06:32:39 -07:00
Miss Islington (bot)
5d62759f98
gh-92436: __future__ docs: add note on expectations for "from __future__ import annotations" (GH-92568)
(cherry picked from commit 6582c96454)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2022-05-12 07:42:57 -07:00