Commit graph

11207 commits

Author SHA1 Message Date
Miss Islington (bot)
95ae29d508
Fix incorrect double indent in ast doc (GH-94976)
Warning directive indent was 4 rather than 3 spaces.
(cherry picked from commit a25a803c4c)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-07-18 10:33:47 -07:00
Miss Islington (bot)
a923eb47c2
In ast doc, update 'below' to 'above' (GH-94967)
The included asdl file was moved from 'below' to 'above' in 3.9.
(cherry picked from commit 7b617be4ab)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-07-18 09:45:09 -07:00
Miss Islington (bot)
6654392587
Add additional pointers to pathlib's mapping to os.path functions (GH-94828)
* Add additional pointers to pathlib's mapping to os.path functions

os.path.splitext has a somewhat quirky signature since it mixes the path and filename components but I wanted the documentation to mention `PurePath.stem` as the natural counterpart to `PurePath.suffix` for the common use of `os.path.splitext` to turn "file.py" into "file" and "py".

Technically this could have some discussion of how to handle the parent directory hierarchy but that seems a bit out of keeping with the spirit of this table so I omitted mentioning `PurePath.parents` here.

* Update Doc/library/pathlib.rst

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

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

Co-authored-by: Chris Adams <chris@improbable.org>
2022-07-15 15:16:45 -07:00
Miss Islington (bot)
c5bf768a53
[3.10] [doc] Update cookbook example and add information about queue types. (GH-94854) (GH-94872)
(cherry picked from commit dc54193095)
2022-07-15 08:18:30 +01:00
Miss Islington (bot)
1cf0305ba5
Docs: fix typo in sqlite3.rst (GH-94798)
Colum -> Column
(cherry picked from commit 9ea72e9d8d)

Co-authored-by: Ikko Ashimine <eltociear@gmail.com>
2022-07-14 14:58:14 -07:00
Miss Islington (bot)
30015de723
GH-77265: Document NaN handling in statistics functions that sort or count (GH-94676) (#94725) 2022-07-10 12:36:01 -05:00
Miss Islington (bot)
da4912885f
Use mdash-es consistently in the library docs index (GH-92762)
(cherry picked from commit efb20a97c4)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-07-08 07:50:56 -07:00
Erlend Egeberg Aasland
691d26a17f
[3.10] gh-94622: Add more references to the sqlite3 types anchor (GH-94623). (#94679)
(cherry picked from commit e5b841a403)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-08 02:50:12 +02:00
Erlend Egeberg Aasland
797745e749
[3.10] gh-94321: Document sqlite3.PrepareProtocol (GH-94620) (#94671)
(cherry picked from commit fb6dccae34)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-08 01:44:09 +02:00
Guy Yagev
860aefaeca
gh-92743: Remove copyright sign next to "Raymond Hettinger" (#94665)
Closes GH-92743
2022-07-07 14:31:39 -07:00
Erlend Egeberg Aasland
663aa6e7d9
[3.10] gh-94628: Add explicit parameter list to sqlite3.connect docs (GH-94629) (#94646)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 3eb2b9634f)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-07 10:46:29 +02:00
Miss Islington (bot)
7f45ae859a
gh-94630: Update sqlite3 docs with positional-only and keyword-only symbols (GH-94631)
(cherry picked from commit 94988603f3)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-06 16:21:05 -07:00
Miss Islington (bot)
7e3b6affa0
gh-94017: Improve clarity of sqlite3 transaction handling docs (GH-94320)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit 760b8cf0c8)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-06 14:07:36 -07:00
Łukasz Langa
fd34bfe484
[3.10] gh-91330: Tests and docs for dataclass descriptor-typed fields (GH-94424) (GH-94577)
Co-authored-by: Erik De Bonte <erikd@microsoft.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 5f319308a8)
2022-07-05 20:45:02 +02:00
Vinay Sajip
3287e45847
[3.10] bpo-46755: Don't log stack info twice in QueueHandler (GH-31355) (GH-94565)
Co-authored-by: Erik Montnemery <erik@montnemery.com>
2022-07-05 16:04:29 +01:00
Łukasz Langa
6e47020d31
[3.10] Docs: remove redundant "adverb-adjective" hyphens from compound modifiers (GH-94551) (GH-94558)
Discussion: https://discuss.python.org/t/slight-grammar-fix-throughout-adverbs-dont-need-hyphen/17021
(cherry picked from commit 3440d197a5)

Co-authored-by: Ned Batchelder <ned@nedbatchelder.com>
2022-07-05 14:30:37 +02:00
Vinay Sajip
817414321c
[3.10] Update logging documentation: change cross-reference and add webapp r… (GH-94542) 2022-07-04 09:10:13 +01:00
Miss Islington (bot)
d793ebc11d
IDLE doc: Tweek RESTART and Windows console start (GH-94530)
(cherry picked from commit 39c29f753e)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-07-03 10:39:20 -07:00
Miss Islington (bot)
cf1732619a
gh-81054: Document that SimpleHTTPRequestHandler follows symbolic links (GH-94416) (GH-94493)
(cherry picked from commit 80aaeabb8b)

Co-authored-by: Sam Ezeh <sam.z.ezeh@gmail.com>
2022-07-01 18:41:40 +02:00
Miss Islington (bot)
e55cd03c15
Update code sample when importing modules in queue doc (GH-94244) (GH-94491)
In the queue documentation, the code snippet shows the import to be not PEP 8 compliant.

Since people typically copy-paste from such code samples, I think it's important to show best-practices here.
(cherry picked from commit ad55147c1d)

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
2022-07-01 18:15:06 +02:00
Miss Islington (bot)
b8544e18e6
multiprocessing.spawn doc: Capitalize the p in "Python" (gh-94462)
(cherry picked from commit 62bb7a3b50)

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
2022-06-30 11:22:58 -07:00
Miss Islington (bot)
d915ed2978
xml.dom.minidom docs: fix typo (GH-93437)
(cherry picked from commit 639e35108b)

Co-authored-by: Jean-Christophe Helary <jean.christophe.helary@traduction-libre.org>
2022-06-30 10:16:06 -07:00
Miss Islington (bot)
e721da5d39
gh-89038: [doc] update dis.findlinestarts documentation for changes related to PEP-626 (GH-94247) (GH-94449)
(cherry picked from commit d68f2d27bb)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-06-30 16:39:48 +01:00
Miss Islington (bot)
2bf974ec84
[3.10] bpo-92336: [doc] clarify that the dfile is read by the traceback display code (GH-94409) (GH-94429)
(cherry picked from commit 68fb03249f)


Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>

Automerge-Triggered-By: GH:iritkatriel
2022-06-29 13:54:44 -07:00
Miss Islington (bot)
eb7d354817
[3.10] gh-82006: IDLE doc improvements (GH-94349) (GH-94358)
0. Update text start and stop conditions.
1. Title-case sections but not subsections.
2. Edit Shell Window sections: title, execute, restart.
(cherry picked from commit e6391e08bf)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2022-06-28 12:50:58 +02:00
Miss Islington (bot)
5f3b45a7f4
gh-70474: [doc] fix wording of GET_ANEXT doc (GH-94048)
(cherry picked from commit 9af6b75298)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-06-25 15:52:06 -07:00
Erlend Egeberg Aasland
deb4d0457f
[3.10] gh-90016: Reword sqlite3 adapter/converter docs (GH-93095) (#94273)
Also add adapters and converter recipes.

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com.
(cherry picked from commit bd3c1c187e)
2022-06-25 22:55:38 +02:00
Miss Islington (bot)
64892c5e36
Docs: Remove Provides [...] from multiprocessing.shared_memory description (GH-92761)
(cherry picked from commit a91ffcf3fa)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-24 10:16:54 -07:00
Miss Islington (bot)
e51a22b6f6
gh-74696: Do not change the current working directory in shutil.make_archive() if possible (GH-93160) (GH-94106)
It is no longer changed when create a zip or tar archive.

It is still changed for custom archivers registered with shutil.register_archive_format()
if root_dir is not None.

Co-authored-by: Éric <merwok@netwok.org>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit fda4b2f063)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-06-22 11:18:37 +02:00
Miss Islington (bot)
ad2e9f97c2
bpo-30535: [doc] state that sys.meta_path is not empty by default (GH-94098) (GH-94100)
Co-authored-by: Windson yang <wiwindson@outlook.com>
(cherry picked from commit 6575841266)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2022-06-21 23:05:08 +01:00
Łukasz Langa
9ab245f8ca
[3.10] gh-93675: Fix typos in Doc/ (GH-93676) (GH-94080)
Closes GH-93675
(cherry picked from commit 830513754d)

Co-authored-by: luzpaz <luzpaz@users.noreply.github.com>
2022-06-21 21:39:08 +02:00
Łukasz Langa
38fdff9274
[3.10] gh-93851: Fix all broken links in Doc/ (GH-93853) (GH-94078)
(cherry picked from commit f62ff97f31)

Co-authored-by: Oleg Iarygin <oleg@arhadthedev.net>
2022-06-21 21:37:09 +02:00
Miss Islington (bot)
223fde359a
gh-86986: Drop compatibility support for Sphinx 2 (GH-93737)
* Revert "bpo-42843: Keep Sphinx 1.8 and Sphinx 2 compatibility (GH-24282)"

This reverts commit 5c1f15b4b1

* Revert "bpo-42579: Make workaround for various versions of Sphinx more robust (GH-23662)"

This reverts commit b63a620014.
(cherry picked from commit 0efe3a1636)

Co-authored-by: Adam Turner <9087854+AA-Turner@users.noreply.github.com>
2022-06-21 10:51:23 -07:00
Miss Islington (bot)
cdf3689aa5
gh-61162: Clarify sqlite3 connection context manager docs (GH-93890)
Explicitly note that transactions are only closed if there is an open
transation at `__exit__`, and that transactions are not implicitly
opened during `__enter__`.

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

Automerge-Triggered-By: GH:erlend-aasland
(cherry picked from commit 8e08978141)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-06-19 13:25:55 -07:00
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
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)
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)
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)
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