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