Commit graph

24851 commits

Author SHA1 Message Date
Miss Islington (bot)
32b71ffbdb
gh-95155: Update "Using Python on a Mac" documentation (GH-95284) (GH-95743)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit d25ff1f613)

Co-authored-by: Howie Zhao <howiezhaohr@hotmail.com>
2022-08-06 19:15:32 +02:00
Miss Islington (bot)
7c711aecf6
gh-89362: Doc IDLE menu and search (GH-95697)
Update menu item position and capitalization.
Add paragraph about search.
For help.html, include save-as addition.
(cherry picked from commit 834064c19a)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-08-05 09:51:53 -07:00
Petr Viktorin
b66b6e1cc0
gh-91271: Document which parts of structs are in limited API/stable ABI (GH-32196) (GH-95711)
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-08-05 17:30:51 +02:00
Miss Islington (bot)
57446f9e33
bpo-42037: Corrected request dependencies in CookieJar functions (GH-23112) (GH-95515)
(cherry picked from commit d29e279de3)

Co-authored-by: markus-sus <73822103+markus-sus@users.noreply.github.com>
2022-08-05 10:20:29 +02:00
Miss Islington (bot)
9e859e1258
GH-95685: Fix rendering of the string documentation (GH-95686) (GH-95701)
There's an extra underlines that messed the rest of the documentation rendering.

Closes #95685
(cherry picked from commit a525f2ada4)

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
2022-08-05 09:58:17 +02:00
Miss Islington (bot)
2351593319
gh-65802: IDLE - explain SaveAs and extensions (GH-95690)
File name extensions may or may not be shown for the current name
and are added in an OS-dependent manner if not given for the new
name.
(cherry picked from commit 9890f86ae2)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-08-04 23:26:26 -07:00
Erlend Egeberg Aasland
c57666586b
[3.10] Docs: sqlite3 docs fixup (GH-95681) (#95684)
- Disable links to the module itself
- Consistent ref markup

(cherry picked from commit 44f1f63ad5)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-05 06:41:09 +02:00
Erlend Egeberg Aasland
54ea127923
[3.10] gh-95271: Extract placeholders howto from sqlite3 tutorial (GH-95522) (#95678)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit b24e8b28a7)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-04 22:53:51 +02:00
Erlend Egeberg Aasland
4a204c1486
[3.10] gh-95273: Improve documented return values and exceptions raised for sqlite3 class methods (GH-95530) (#95674)
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>.
(cherry picked from commit 12d92c733c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-04 22:14:02 +02:00
Miss Islington (bot)
f6b1c5e454
Docs: fix two typos in the sqlite3 docs (GH-95661)
- statment => statement
- transaciton => transaction
(cherry picked from commit 962acd4468)

Co-authored-by: ceh <emil@hessman.se>
2022-08-04 11:34:37 -07:00
Miss Islington (bot)
be30a6dc4d
gh-91838: Resolve HTTP links which redirect to HTTPS (GH-95642)
It updates links which redirect to HTTPS with different authority or
path.
(cherry picked from commit d0d0154443)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-08-04 06:15:01 -07:00
Serhiy Storchaka
54d4b4d992
[3.10] gh-91838: Use HTTPS links in docs for resources which redirect to HTTPS (GH-95527) (GH-95644)
If an HTTP link is redirected to a same looking HTTPS link, the latter can
be used directly without changes in readability and behavior.
It protects from a men-in-the-middle attack.

This change does not affect Python examples..
(cherry picked from commit f79547a429)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2022-08-04 12:19:44 +03:00
Miss Islington (bot)
b6503fa795
gh-95191: IDLE Prompts entry for What's New 3.10 (GH-95633)
(cherry picked from commit bcc74d509a)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-08-03 19:27:16 -07:00
Shantanu
a05dae2348
[3.10] gh-91423: Remove bugs.python.org from bugs.rst (GH-91425) (#95615)
* Remove bugs.python.org from bugs.rst

* Update bugs.rst to the github issue tracker

* reflow

* Fix a typo and rephrase a sentence.

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
Co-authored-by: Ezio Melotti <ezio.melotti@gmail.com>
(cherry picked from commit df81d2892e)

Co-authored-by: roy reznik <royreznik@gmail.com>

Co-authored-by: roy reznik <royreznik@gmail.com>
2022-08-04 00:39:51 +02:00
Steve Dower
76d29a8ae8
gh-95423: Update winreg.DeleteKeyEx documentation and remove dynamic function load (GH-95521)
Co-authored-by: Derek Kim <ddkim1024@gmail.com>
2022-08-03 22:52:15 +01:00
Erlend Egeberg Aasland
ac005ea860
[3.10] gh-95273: Align sqlite3 const doc refs with the devguide recommendations (GH-95525). (#95618)
(cherry picked from commit 4d02572f8c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-08-03 23:04:35 +02:00
CAM Gerlach
7c5f13f391
gh-91207: Override stylesheet fingerprinting when building for HTML Help (GH-95556) 2022-08-02 20:04:12 +01:00
Miss Islington (bot)
8a7bf2d28c
gh-95233: Correct grp.getgrgid parameter name in documentation (gid -> id) (gh-95232)
(cherry picked from commit df7c8b9537)

Co-authored-by: Adam Dangoor <adamdangoor@gmail.com>
2022-08-02 08:02:33 -07:00
Miss Islington (bot)
8e1952aaaf
gh-92219: Clarify that some options to the installer may break the install (GH-95548) (#95550)
(cherry picked from commit d2c1a9c76c)

Co-authored-by: Steve Dower <steve.dower@python.org>
2022-08-02 15:06:15 +02:00
Miss Islington (bot)
a1579ade9c
gh-95516: Add param types and clarify param descriptions of LogRecord (GH-95517) (#95565)
(cherry picked from commit 75a6441718)

Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
2022-08-02 15:05:46 +02:00
Erlend Egeberg Aasland
6765a784a7
[3.10] gh-94635: Add Reference, How-to, and Explanation headings to sqlite3 docs (GH-94636) (#95483)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 6c439b978b)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>

* Fix refs
2022-07-31 08:47:53 +02:00
Miss Islington (bot)
f14ced6062
gh-95273: Relocate sqlite3 enable load extension note (GH-95430)
(cherry picked from commit d92b19e1b5)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-29 12:36:58 -07:00
Miss Islington (bot)
3417ce3489
gh-95432: Fixup sqlite3 tutorial example (GH-95431)
- the insert statement should have five placeholders, not four
- missing ... in the multiline row list
(cherry picked from commit 2fbee85931)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-29 05:38:08 -07:00
Miss Islington (bot)
a41b51d2ea
gh-95273: Improve sqlite3 class descriptions (GH-95379)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit e003b64f40)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-29 03:00:29 -07:00
Miss Islington (bot)
2278dc7442
gh-95273: Condense sqlite3 executescript example (GH-95383) (#95419)
(cherry picked from commit e9c8de669d)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-29 10:44:29 +02:00
Miss Islington (bot)
f59a5c5363
gh-95273: Move sqlite3 executemany examples from reference to tutorial (GH-95351)
(cherry picked from commit f0bf7956e6)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-29 00:48:55 -07:00
Miss Islington (bot)
5632c98f4a
Improve documentation for adding datetime and timedelta (gh-95403) (gh-95409)
(cherry picked from commit 6e44bf9558)

Co-authored-by: BenjaminHelyer <91896754+BenjaminHelyer@users.noreply.github.com>

Co-authored-by: BenjaminHelyer <91896754+BenjaminHelyer@users.noreply.github.com>
2022-07-28 20:15:24 -04:00
Miss Islington (bot)
196523f32b
gh-86128: Add warning to ThreadPoolExecutor docs about atexit behaviour (GH-94008)
(cherry picked from commit 7df2f4d787)

Co-authored-by: [object Object] <lucas.wiman@gmail.com>
2022-07-28 15:48:19 -07:00
Miss Islington (bot)
dcb6fa8099
Docs: Fix refs & tweak wording in sqlite3 'Using shortcut methods' (#95358)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit ea269b9a38)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-28 12:32:20 +02:00
Erlend Egeberg Aasland
2ef7a72682
[3.10] gh-95273: Normalise sqlite3 reference wording (GH-95274) (#95330)
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 2361908a9d)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2022-07-27 15:42:59 +02:00
Miss Islington (bot)
7e7a570818
gh-94630: Fixup sqlite3 argument spec docs for connection execute* methods (GH-95319)
(cherry picked from commit 2b37395612)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-27 05:54:14 -07:00
Miss Islington (bot)
321b8bbf0f
gh-94635: Add sqlite3 'Introduction' and 'Tutorial' doc headings (GH-95269)
(cherry picked from commit 2e35a13e46)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-26 22:49:29 -07:00
Erlend Egeberg Aasland
a4fd732155
[3.10] gh-95235: Add explicit parameter list to some sqlite3 methods (GH-95240) (#95268)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>.
(cherry picked from commit 5012bedc7c)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-26 10:12:50 +02:00
Miss Islington (bot)
0418d9f2f3
gh-95235: Document undocumented parameters in sqlite3 functions and methods (GH-95236)
Co-authored-by: CAM Gerlach <CAM.Gerlach@Gerlach.CAM>
(cherry picked from commit ac6a94c669)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-25 09:55:46 -07:00
Miss Islington (bot)
e71e6e2ce5
Doc: Add omitted secondary prompt in inputoutput tutorial (GH-30317) (#95159)
For the continuation lines, "..." should present as secondary prompt
(cherry picked from commit de28ee8f75)

Co-authored-by: Chenwei Xiao <chanvinxiao@163.com>

Co-authored-by: Chenwei Xiao <chanvinxiao@163.com>
2022-07-23 18:28:15 +08:00
Miss Islington (bot)
9f4d0e807d
Fix copy-friendliness of tutorial example (GH-93424)
(cherry picked from commit 34d11f1b0c)

Co-authored-by: Chenwei Xiao <chanvinxiao@163.com>
2022-07-22 13:21:07 -07:00
Miss Islington (bot)
665e5585f4
Fix async method reference links in compound_stmts docs (GH-94935)
(cherry picked from commit 79d2f549ad)

Co-authored-by: July Tikhonov <july.tikh@gmail.com>
2022-07-22 10:11:25 -07:00
Miss Islington (bot)
e50a63ed18
Closes gh-95133: docs, fix indentation level in TestCase.assertLogs example (GH-95134)
(cherry picked from commit 2a9c227ac1)

Co-authored-by: Alexandru Mărășteanu <alexei@users.noreply.github.com>
2022-07-22 09:45:58 -07:00
Miss Islington (bot)
02f1cac282
gh-81040: Improve sqlite3.Cursor.rowcount docs (GH-94940)
(cherry picked from commit f9b3706df6)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@protonmail.com>
2022-07-22 00:41:56 -07:00
Miss Islington (bot)
79561860cd
gh-95112: Fix What's New 3.10 contribution note periods (GH-95114)
Some are missing, a few placed after the ')'.
One ') was missing.
(cherry picked from commit c944649ffc)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2022-07-21 17:08:47 -07:00
Miss Islington (bot)
b60c3d2f7e
GH-95029: Describe Windows Store package isolation and redirection in more detail (GH-95030)
(cherry picked from commit b1924b1006)

Co-authored-by: Anthony Shaw <anthony.p.shaw@gmail.com>
2022-07-20 17:10:32 -07:00
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)
8a01502e2d
gh-90359: Unify documentation style for datetime.rst (gh-94836)
(cherry picked from commit 967da5febb)

Co-authored-by: Dong-hee Na <donghee.na@python.org>
2022-07-13 17:51:03 -07:00
Miss Islington (bot)
381b86bde8
gh-90359: Update documentation to follow PEP 495. (gh-94800)
(cherry picked from commit 07374cce52)

Co-authored-by: Dong-hee Na <donghee.na@python.org>
2022-07-13 17:16:44 -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