Commit graph

23405 commits

Author SHA1 Message Date
Miss Skeleton (bot)
e89253756c
[doc] Fix link to abc.collections.Iterable (GH-22520)
Missed this occurrence before, sorry. Also changed "the PEP" to "PEP".

Automerge-Triggered-By: @gvanrossum
(cherry picked from commit 3fe6148937)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-03 09:13:14 -07:00
Miss Skeleton (bot)
ef7b937b8f
[3.9] bpo-40833: Clarify Path.rename doc-string regarding relative paths (GH-20554)
(cherry picked from commit f97e42ef4d)

Co-authored-by: Ram Rachum <ram@rachum.com>
2020-10-03 13:44:14 +03:00
Miss Skeleton (bot)
ebc8072c3d
[doc] Fix link to abc.collections.Iterable (GH-22502)
Automerge-Triggered-By: @gvanrossum
(cherry picked from commit d4b9edd505)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-10-02 16:36:51 -07:00
Miss Islington (bot)
6dc8e0eb9b
bpo-41802: Document 'PyDict_DelItem' can raise a 'KeyError' (GH-22291)
(cherry picked from commit 20ce62f009)

Co-authored-by: Campbell Barton <ideasman42@gmail.com>
2020-10-02 09:39:20 -07:00
Miss Islington (bot)
8fc828ec4e
Fix grammar in secrets module documentation (GH-22467)
From `In particularly,` to `In particular,`
(cherry picked from commit 63298930fb)

Co-authored-by: Max Smolens <msmolens@users.noreply.github.com>
2020-09-30 15:49:52 -07:00
Miss Islington (bot)
868c8e41eb
bpo-41774: Add programming FAQ entry (GH-22402)
In the "Sequences (Tuples/Lists)" section, add
"How do you remove multiple items from a list".
(cherry picked from commit 5b0181d1f6)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2020-09-28 22:27:06 -07:00
Miss Islington (bot)
bdf46bc7e1
[doc] Leverage the fact that the actual types can now be indexed for typing (GH-22340)
This shows users that they can use the actual types. Using deprecated types is confusing.

This also prefers colections.abc.Sized instead of the alias typing.Sized. I guess the aliases were created to make it convenient to import all collections related types from the same place.

This should be backported to 3.9.

Automerge-Triggered-By: @gvanrossum
(cherry picked from commit d9ab95ff1f)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-27 12:42:29 -07:00
Miss Islington (bot)
8b2595f68a
bpo-41858: Clarify line in optparse doc (GH-22407)
The existing line is easily read as being incomplete.
(cherry picked from commit 00eb063b66)

Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com>
2020-09-26 21:03:56 -07:00
Miss Islington (bot)
57e7d5c19e
bpo-41844: Add IDLE section to What's New 3.9 (GN-22382)
(cherry picked from commit 22b7616f26)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2020-09-23 11:51:50 -04:00
Miss Islington (bot)
e33fe6c3d7
bpo-33822: Update IDLE section of What's New 3.8 (GH-22383)
(cherry picked from commit 9c4eac7f02)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2020-09-23 08:37:52 -07:00
Miss Islington (bot)
64362c2e43
bpo-37062: Enum: add extended AutoNumber example (GH-22349) (GH-22370)
(cherry picked from commit 62e40d8450)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2020-09-22 20:58:32 -07:00
Miss Islington (bot)
f27a1577d3
bpo-35764: Rewrite the IDLE Calltips doc section (GH-22363) 2020-09-22 14:35:38 -04:00
Victor Stinner
9e73cac173
bpo-35293: Travis CI uses "make venv" for the doc (GH-22307) (GH-22309)
Doc/requirements.txt becomes the reference for packages and package
versions needed to build the Python documentation.

* Doc/Makefile now uses Doc/requirements.txt
* .travis.yml now uses "make env" of Doc/Makefile
* Update Sphinx to version 2.4.4

(cherry picked from commit 8394500cca)
2020-09-18 16:53:46 +02:00
Miss Islington (bot)
f3e0eceff6
bpo-35293: Remove RemovedInSphinx40Warning (GH-22198)
* bpo-35293: Remove RemovedInSphinx40Warning

* Update Misc/NEWS.d/next/Documentation/2020-09-12-17-37-13.bpo-35293._cOwPD.rst

Co-authored-by: Victor Stinner <vstinner@python.org>

* bpo-35293: Apply Victor's review

Co-authored-by: Victor Stinner <vstinner@python.org>
(cherry picked from commit 6595cb0af4)

Co-authored-by: Dong-hee Na <donghee.na92@gmail.com>
2020-09-18 02:38:41 -07:00
Miss Islington (bot)
c053402927
bpo-41762: Fix usage of productionlist markup in the doc (GH-22281)
Use an unique identifier for the different grammars documented using
the Sphinx productionlist markup.

productionlist markups of the same grammar, like "expressions" or
"compound statements", use the same identifier "python-grammar".
(cherry picked from commit 8af239eacf)

Co-authored-by: Victor Stinner <vstinner@python.org>
2020-09-18 00:27:21 -07:00
Serhiy Storchaka
6d893bab77
[3.9] Remove duplicated words words (GH-22298). (GH-22299)
(cherry picked from commit 27201cddf3)
2020-09-18 10:13:57 +03:00
Serhiy Storchaka
234ae8fe1b
[3.9] Remove duplicated words words (GH-20413). (GH-22296)
(cherry picked from commit 1c5d1d7304)
2020-09-18 09:36:14 +03:00
Terry Jan Reedy
4daeb9eec2
[3.9] bpo-27032, bpo-37328: Document removing HTMLParser.unescape() (GH-22288)
(cherry picked from commit a33f2c2bae)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2020-09-17 20:47:22 -04:00
Miss Islington (bot)
0374883734
Improve the description of difflib in the documentation (GH-22253) (#22261)
From "can produce difference information in various formats ..."
to " can produce information about file differences in various formats ..."

Automerge-Triggered-By: @Mariatta
(cherry picked from commit 5531269f69)

Co-authored-by: Mandeep <mandeep052@gmail.com>
2020-09-15 12:45:05 -07:00
Miss Islington (bot)
0cc037f8a7
bpo-41776: Revise example of "continue" in the tutorial documentation (GH-22234) (GH-22255)
Revise example of "continue" in the tutorial documentation
(cherry picked from commit 7bcc6456ad)

Co-authored-by: Neeraj Samtani <neerajjsamtani@gmail.com>

Co-authored-by: Neeraj Samtani <neerajjsamtani@gmail.com>
2020-09-15 09:56:28 -04:00
Miss Islington (bot)
b502c7618d
bpo-40721: add note about enum member name case (GH-22231)
* UPPER_CASE preferred as enum members are constants
(cherry picked from commit 542e1df2b0)

Co-authored-by: Ethan Furman <ethan@stoneleaf.us>
2020-09-14 13:49:29 -07:00
Emmanuel Arias
b3d11abcbc
[3.9] bpo-41778: Change a punctuation on documentation. (GH-22229) (GH-22232)
On this paragrapah the clarification about IIS7 seems there's not
connection beacuase is in other sentence. Move the punctuation
to connect both the last sentence with the information in the
parenthesis.

I think the NEWS is not necessary here.

Automerge-Triggered-By: @ericvsmith
(cherry picked from commit 94bfdee25d)

Co-authored-by: Emmanuel Arias <eamanu@yaerobi.com>
2020-09-13 17:38:01 -04:00
Miss Islington (bot)
c978be283d
bpo-33239: Fix default value of 'buffering' parameter in docs of tempfile.* functions (GH-21763) (GH-22225)
(cherry picked from commit b48389d950)
2020-09-13 19:20:38 +01:00
Miss Islington (bot)
98f6e67a3d
bpo-41672: Fix type mismatches in imaplib docs (GH-22207)
(cherry picked from commit c75330605d)

Co-authored-by: Norbert Cyran <cyran.norbert97@gmail.com>
2020-09-12 01:14:37 -07:00
Miss Islington (bot)
c97e402a4c
[doc] struct: update note about network byte order form to be more helpful (GH-22201)
Update the sentence to provide some context on why network byte order is defined as big endian.
(cherry picked from commit fb27187203)

Co-authored-by: Stargirl Flowers <theaflowers@google.com>
2020-09-11 08:35:23 -07:00
Miss Islington (bot)
7af6bf4dad
Doc: Fix alphabetical ordering of removeprefix/suffix. (GH-22194)
(cherry picked from commit 3304cbd990)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2020-09-10 17:13:56 -07:00
Miss Islington (bot)
1b4bdb4cd7
bpo-37149: Change Shipman tkinter link from archive.org to TkDocs (GH-22188)
The new link responds much faster and begins with a short explanation of the status of the doc.
(cherry picked from commit 06d0b8b67e)

Co-authored-by: Mark Roseman <mark@markroseman.com>
2020-09-10 13:19:29 -07:00
Miss Islington (bot)
b86e62644f
[doc] Remove superfluous comment about equal in f-strings (GH-22006)
Automerge-Triggered-By: @kushaldas
(cherry picked from commit 788b79fa7b)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-09 23:48:54 -07:00
Miss Islington (bot)
41dbd6e484
Add missing colon to IDLE doc markup (GH-22007)
(cherry picked from commit 7a797a3967)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-09 15:29:51 -07:00
Ammar Askar
46bc21e178
[3.9] bpo-41688: Document bug in **= dispatching in the language data… (GH-22172)
I tossed in a "This bug is fixed in Python 3.10" sentence but I'm not sure if that's appropriate to have here.
2020-09-09 11:01:38 -07:00
Miss Islington (bot)
014b4ef0a1
Fixes dead links to Django's logging config docs (GH-20823) (GH-22170)
(cherry picked from commit 714217f956)
2020-09-09 14:45:08 +01:00
Miss Islington (bot)
fd1c725867
[doc] Fix padding in timeit (GH-22152)
Compare -p and -u options help in rendered output to see the difference.
(cherry picked from commit 594f0ce73b)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-08 16:56:02 -07:00
Benjamin Peterson
b6d2acb1b1
[3.9] closes bpo-41723: Fix an error in the py_compile documentation. (GH-22118)
(cherry picked from commit 5371a46)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-09-05 22:54:46 -05:00
Miss Islington (bot)
e4b359de76
[3.9] [doc] Fix padding in some typing definitions (GH-22114) (GH-22115)
Automerge-Triggered-By: @gvanrossum
(cherry picked from commit 2623868ede)


Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-05 19:54:12 -07:00
Miss Islington (bot)
fbb9ee0a90
[3.9] bpo-38787: Clarify docs for PyType_GetModule and warn against common mistake (GH-20215) (GH-21984)
(cherry picked from commit d9a966ae08)


Co-authored-by: Petr Viktorin <encukou@gmail.com>

Automerge-Triggered-By: @Mariatta
2020-09-04 15:32:28 -07:00
Miss Islington (bot)
bf8bf1c0dc
[3.9] Improve asyncio-dev 'Concurrency and Multithreading' docs (GH-20882) (GH-22009)
I added some information to the `Concurrency and Multithreading` section of the `Developing with asyncio` guide. 

This is all information that would have helped me when I started using asyncio. I incorrectly assumed that `loop.call_soon_threadsafe()` and `run_coroutine_threadsafe()` could be called from a thread in a process separate from the one that the event loop is running in. Explicitly stating that this will not work will probably help some people starting out with asyncio in the future.

I also added references to some other functions that can be used for inter-process communication without blocking the event loop. The section already mentions running blocking code in a ThreadPoolExecutor, but I think listing these other options in this section will also be helpful.
(cherry picked from commit c68c5af2dc)


Co-authored-by: Roger Iyengar <ri@rogeriyengar.com>
2020-09-04 15:31:06 -07:00
Miss Islington (bot)
bd078df283
[3.9] bpo-40486: Specify what happens if directory content change diring iteration (GH-22025) (GH-22093)
(cherry picked from commit 306cfb3a37)


Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2020-09-04 15:29:06 -07:00
Miss Islington (bot)
78ef1b6b12
[3.9] Fix error in argparse documentation example (GH-17399) (GH-21992)
Automerge-Triggered-By: @rhettinger
(cherry picked from commit 8784d3300e)


Co-authored-by: SarahPythonista <4283226+SarahPythonista@users.noreply.github.com>
2020-09-04 15:26:22 -07:00
Miss Islington (bot)
672d8b9190
[3.9] [doc] Fix a typo in the graphlib docs (GH-22030) (GH-22076)
(cherry picked from commit 8516060076)


Co-authored-by: Mario Šaško <mariosasko777@gmail.com>
2020-09-04 15:25:50 -07:00
Miss Islington (bot)
6386e86bec
bpo-38585: Remove references to defusedexpat (GH-22095)
defusedexpat is not maintained.
(cherry picked from commit 51b84f8e96)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-09-04 14:17:45 -07:00
Miss Islington (bot)
a5d0232b0d
bpo-39883: Use BSD0 license for code in docs (GH-17635) (GH-22073)
The PSF board approved this use.
(cherry picked from commit e223d06a8b)

Co-authored-by: Todd <toddrjen@gmail.com>
2020-09-03 07:40:10 -07:00
Miss Islington (bot)
27183f48f2
Fix invalid escape sequences in the peg_highlight Sphinx extension (GH-22047) (GH-22065)
(cherry picked from commit 5a4a963a6c)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2020-09-02 17:43:43 +01:00
Miss Islington (bot)
bafaf07275
[doc] Remove references to PyChecker. (GH-22054)
(cherry picked from commit dea82b6731)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-02 08:29:33 -05:00
Miss Islington (bot)
e2e033807f
Remove reference to Boa Constructor. (GH-22056)
(cherry picked from commit 1d25f5bf7b)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-09-02 08:29:16 -05:00
Miss Islington (bot)
e2977f6202
Note the buffer slots can be set with PyType_Spec with the unlimited API. (GH-22052)
Follow up to f7c4e23642.
(cherry picked from commit 700fa1b836)

Co-authored-by: Benjamin Peterson <benjamin@python.org>
2020-09-01 22:18:21 -05:00
Miss Islington (bot)
6b5e88744c
bpo-41634: Fix a typo in the curses documentation (GH-21958)
(cherry picked from commit 398575c210)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2020-08-29 18:33:48 -04:00
Karthikeyan Singaravelan
c01a7edc67
[3.9] bpo-41624: fix documentation of typing.Coroutine (GH-21952) (#21982)
(cherry picked from commit 8c58d2a)

Co-authored-by: MingZhe Hu <humingzhework@163.com>

Co-authored-by: MingZhe Hu <humingzhework@163.com>
2020-08-28 08:06:31 -07:00
Miss Islington (bot)
d7cd1164c1
Document vars behavior when __dict__ is missing (GH-21466) (GH-21939)
(cherry picked from commit 802726acf6)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2020-08-22 15:55:00 -03:00
Miss Islington (bot)
72d5ddb930
Fix grammar in Doc/tutorial/controlflow.rst (GH-21885) (#21922)
Automerge-Triggered-By: @csabella
(cherry picked from commit 0be7c216e1)

Co-authored-by: Denis Ovsienko <denis@ovsienko.info>
2020-08-22 05:08:02 -04:00
Miss Islington (bot)
f497bbeed0
bpo-40994: Ungroup items in collections.abc documentation for improved clarity (GH-21880) (#21926)
Use a less surprising document structure.

Automerge-Triggered-By: @csabella
(cherry picked from commit 2ce39631f6)

Co-authored-by: Sydney Pemberton <46042811+sydneypemberton1986@users.noreply.github.com>
2020-08-22 05:06:54 -04:00