Commit graph

10455 commits

Author SHA1 Message Date
Steve Dower
34f93002ba
bpo-42999: Expand and clarify pathlib.Path.link_to() documentation. (GH-24294)
Co-authored-by: Barney Gale <barney.gale@gmail.com>
2021-04-07 18:12:42 +01:00
Miss Islington (bot)
c7ccb0ff61
bpo-17305: Link to the third-party idna package. (GH-25208)
So long as we don't have idna2008 in the standard library, we should at least point people to the third-party solution.
(cherry picked from commit 1d023e374c)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2021-04-06 01:19:15 -07:00
Miss Islington (bot)
d56bcf915b
[3.9] bpo-41370: Add note about ForwardRefs and PEP585 generic types in docs (GH-25183) (GH-25184)
(cherry picked from commit 2b5913b4ee)


Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>

Automerge-Triggered-By: GH:gvanrossum
2021-04-04 08:36:21 -07:00
Miss Islington (bot)
63c69440c7
bpo-43705: Document that SyntaxError's offsets are 1-indexed (GH-25153)
Changed the inline mentions of the attributes into a proper attribute list like `SystemExit` has.

Automerge-Triggered-By: GH:gvanrossum
(cherry picked from commit b2a91e0c9e)

Co-authored-by: Ammar Askar <ammar@ammaraskar.com>
2021-04-02 15:26:32 -07:00
Miss Islington (bot)
244fa236e4
Doc: io: Remove "In-memory streams" section (GH-24927)
(cherry picked from commit b045cdaf34)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2021-04-01 15:11:49 +09:00
Miss Islington (bot)
b3c1e2c493
bpo-42840: Document providing kwargs to type. (GH-24173)
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 72fcd14a82)

Co-authored-by: Erik Soma <stillusingirc@gmail.com>
2021-03-31 17:10:36 -07:00
Miss Islington (bot)
84694c3e7a
bpo-42225: IDLE - document two unix-related problems. (GH-25078)
1. Bad IP masquerade rules can prevent startup.
2. X cannot handle some complex colored chars.
(cherry picked from commit 1b4a9c7956)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-03-30 22:44:26 -07:00
Miss Islington (bot)
9a8e078024
bpo-31907: [doc] clarify that str.format() does not support arbitrary expressions (GH-25053) (GH-25055)
(cherry picked from commit fb1d01b963)

Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>

Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
2021-03-28 17:05:07 -04:00
Miss Islington (bot)
138e039ff9
bpo-43644: Add docs for importlib.resources.as_file. (GH-25048)
(cherry picked from commit af50c84643)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
2021-03-27 17:48:53 -07:00
Miss Islington (bot)
c84e769c2b
bpo-39616: clarify SSLContext.check_hostname effect (GH-18484)
It doesn't actually affect whether match_hostname() is called (it
never is in this context any longer), but whether hostname
verification occurs in the first place.
(cherry picked from commit 9798cef92b)

Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
2021-03-27 07:42:45 -07:00
Miss Islington (bot)
f311290f09
bpo-43620: Remove reference to os.sep from os.path.join() doc (GH-25025) (#25027)
- removed ambiguous reference to os.sep from os.path.join() doc
(cherry picked from commit 21a2cabb37)

Co-authored-by: Jared Sutton <jpsutton@gmail.com>
2021-03-26 13:24:19 -04:00
Miss Islington (bot)
10e17bc693
Clarify attribute docs on types.ModuleType (GH-24974)
(cherry picked from commit 76b5d714e4)

Co-authored-by: Brett Cannon <brett@python.org>
2021-03-23 09:01:10 -07:00
Miss Islington (bot)
4cc9e2348b
Add a warning block around the get_referrers() documentation (GH-24511)
(cherry picked from commit 813db24f7c)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2021-03-17 17:26:07 -07:00
Miss Islington (bot)
2fe408497e
[3.9] [doc] Document logging.basicConfig default format (GH-23710) (GH-24835)
(cherry picked from commit 35cacce525)
2021-03-15 09:41:00 +00:00
Miss Islington (bot)
bb46c135ad
Fix typos in unittest documentation (GH-24194)
* addCleanupClass  -> addClassCleanup
* doCleanupsClass -> doClassCleanups
(cherry picked from commit e0e398ef18)

Co-authored-by: Conchylicultor <etiennefg.pot@gmail.com>
2021-03-13 16:27:53 -08:00
Miss Islington (bot)
5c674e4479
Update link to Django's Context class. (GH-24805) (#24841)
* Update link to Django's Context class.
* Update link to get-pip.py.
(cherry picked from commit d0a445490e)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2021-03-13 04:34:46 -08:00
Mariusz Felisiak
4d7f11e057
[3.9] bpo-43353: Document that logging.getLevelName() accepts string representation of logging level. (GH-24693) (GH-24826)
(cherry picked from commit bbba28212c)

Automerge-Triggered-By: GH:vsajip
2021-03-12 00:46:07 -08:00
Pablo Galindo
f814675376
[3.9] bpo-43439: Add audit hooks for gc functions (GH-24794). (GH-24811)
(cherry picked from commit b4f9089d4a)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2021-03-10 00:50:29 -08:00
Miss Islington (bot)
da602560a4
bpo-43446: Fix markup in sqlite3 footnote (GH-24806)
(cherry picked from commit 62a03cd490)

Co-authored-by: Kamil Turek <kamil.turek@hotmail.com>
2021-03-10 01:43:17 +02:00
Miss Islington (bot)
fb3b031030
bpo-43415: Fix typo on dataclasses.rst (GH-24789) (GH-24790)
(cherry picked from commit 0554044ddc)

Co-authored-by: Guilherme Martins Crocetti <gmcrocetti@gmail.com>

Co-authored-by: Guilherme Martins Crocetti <gmcrocetti@gmail.com>
2021-03-08 17:52:43 -05:00
Miss Islington (bot)
2c0a0b04a4
Put contextvars docs into the concurrency category (GH-24760)
(cherry picked from commit 5eb7796b7f)

Co-authored-by: Brett Cannon <brett@python.org>
2021-03-06 08:48:12 -08:00
Miss Islington (bot)
65f3a0d20c
bpo-43407: Clarify comparisons of time.monotonic() et al results (GH-24757)
Previous wording implied that only the result of call N and N+1 could be
meaningfully compared, whereas comparing call N and N+M is fine.
(cherry picked from commit ff5f05934d)

Co-authored-by: Alex Willmer <alex@moreati.org.uk>
2021-03-05 17:48:33 -08:00
Miss Islington (bot)
0dd4cb944b
bpo-43400: Remove "easy to use" from mock docs (GH-24752) (GH-24758) 2021-03-04 16:35:43 -08:00
Miss Islington (bot)
374ee44933
bpo-43396: Normalise naming in sqlite3 doc examples (GH-24746)
(cherry picked from commit 40d1b831ec)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-03-04 19:11:40 +02:00
Miss Islington (bot)
ff6a021c25
Add an attribution to the Green Tree Snakes in the AST docs (GH-24727)
(cherry picked from commit 62e3b6370c)

Co-authored-by: Pablo Galindo <Pablogsal@gmail.com>
2021-03-03 10:48:56 -08:00
Miss Islington (bot)
f836e5f219
Doc: Improve library/json document. (GH-24390)
(cherry picked from commit a347bc0b35)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2021-03-01 18:15:05 -08:00
Miss Islington (bot)
4f9eb3f3d3
Fix grammar in enum documentation. (GH-24689)
There is an extra `s` in the singular word `method`.
Reported in docs mailing list by Steven Nguyen.

Automerge-Triggered-By: GH:Mariatta
(cherry picked from commit f193874056)

Co-authored-by: Mariatta Wijaya <Mariatta@users.noreply.github.com>
2021-03-01 11:21:05 -08:00
Miss Islington (bot)
f82578ace1
bpo-43293: Doc: move note about GIL to top of threading module (GH-24622)
The note about the GIL was buried pretty deep in the threading documentation,
and this made it hard for first time users to discover why their attempts
at using threading to parallelizing their application did not work.

In this commit, the note is moved to the top of the module documention for
visibility.
(cherry picked from commit 32181be608)

Co-authored-by: Guanzhong Chen <quantum2048@gmail.com>
2021-02-24 11:01:33 -08:00
Miss Islington (bot)
e202f1e4db
bpo-43283: Add IDLE doc paragraph about print speed (GH-24615)
Printing to IDLE's Shell is often slower than printing to a system
terminal, but it can be made faster by pre-formatting a single
string before printing.
(cherry picked from commit 2827e8a177)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-02-23 17:03:37 -08:00
Miss Islington (bot)
30fe3ee6d3
bpo-23882: Doc: Clarify unittest discovery document (GH-21560)
Unittest discovery support namespace package as start
directory. But it doesn't find namespace package in
the start directory automatically.

Otherwise, unittest discovery search into unexpected
directories like `vendor/` or `node_modules/`.
(cherry picked from commit 5a4aa4c03e)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2021-02-21 22:37:18 -08:00
Miss Islington (bot)
693aeacf88
bpo-43283: Rearrange some IDLE doc paragraphs. (GH-24604)
In the Running User Code section, gather together paragraphs about two
processes and the sys.stdstream replacements, preparing to add another.
(cherry picked from commit 4cf7bb8e22)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-02-21 00:07:33 -08:00
Miss Islington (bot)
216cb1469f
Fix typo in dis module doc (GH-24509)
(cherry picked from commit 292f23186c)

Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
2021-02-19 20:46:34 -08:00
Pablo Galindo
9cc70bc220
[3.9] Minor improvements to the convolve() recipe (GH-24520) 2021-02-15 23:02:41 +00:00
Senthil Kumaran
c9f07813ab
[3.9] bpo-42967: only use '&' as a query string separator (GH-24297) (#24528)
(cherry picked from commit fcbe0cb04d)

* [3.9] bpo-42967: only use '&' as a query string separator (GH-24297)

bpo-42967: [security] Address a web cache-poisoning issue reported in urllib.parse.parse_qsl().

urllib.parse will only us "&" as query string separator by default instead of both ";" and "&" as allowed in earlier versions. An optional argument seperator with default value "&" is added to specify the separator.

Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Adam Goldschmidt <adamgold7@gmail.com>
2021-02-15 10:03:31 -08:00
Miss Islington (bot)
242f6c9ffe
bpo-43200: Fix link to shutil.copy() in the shutil doc (GH-24505)
Co-authored-by: Zackery Spytz <zspytz@gmail.com>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 762fe7deed)
2021-02-13 00:20:24 -05:00
Ken Jin
917eca700a
bpo-41824: Add versionadded for typing.ForwardRef docs (#24224) (#24493) 2021-02-09 08:55:03 -08:00
Miss Islington (bot)
863eb7170b
bpo-16781: In 'exec' doc, add 'nonlocal' to 'yield' and 'return' (GH-2446)
These 3 statements cannot be used at module scope -- nor in exec with one namespace.
(cherry picked from commit 0ec57e25c9)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-02-07 09:14:16 -05:00
Miss Islington (bot)
926ca51be4
bpo-43059: Remove reference to legacy external sqlite3 repository (GH-24364)
(cherry picked from commit e603443642)

Co-authored-by: L <3177243+LukeLR@users.noreply.github.com>
2021-01-31 07:21:28 +02:00
Miss Islington (bot)
d34be1ed57
Fixing typos in turtle.rst (GH-24376)
Automerge-Triggered-By: GH:JulienPalard
(cherry picked from commit 6baaae589d)

Co-authored-by: Jules Lasne <jules.lasne@gmail.com>
2021-01-29 14:03:18 -08:00
Miss Islington (bot)
44cd24452a
Fixed typo in turtle.rst (GH-24371)
Found it while translating it to french 🤷

Automerge-Triggered-By: GH:JulienPalard
(cherry picked from commit 6372a4ceba)

Co-authored-by: Jules Lasne <jules.lasne@gmail.com>
2021-01-29 13:38:16 -08:00
Miss Islington (bot)
68102fb998
bpo-43008: Make IDLE respect sys.excepthook (GH-24302)
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
(cherry picked from commit 7a34380ad7)

Co-authored-by: Ken <kenny2minecraft@gmail.com>
2021-01-26 16:24:14 -08:00
Miss Islington (bot)
98e1f5c778
bpo-40304: Correct type(name, bases, dict) doc (GH-19553)
Co-authored-by: Éric Araujo <merwok@netwok.org>
Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
(cherry picked from commit 644d52818a)

Co-authored-by: Борис Верховский <boris.verk@gmail.com>
2021-01-21 22:09:50 -08:00
Yair Frid
8c3914aef4
[3.9] bpo-42811: Update importlib.utils.resolve_name() docs to use __spec__.parent (GH-24100) (GH-24149)
This is a backport of 
https://github.com/python/cpython/pull/24100

Automerge-Triggered-By: GH:brettcannon
2021-01-07 10:06:13 -08:00
Vladimir
49c150f1f1
bpo-38413: Remove outdated section about multithreading in sqlite3 (GH-23159)
(cherry picked from commit f9949f82e1)
2021-01-06 22:57:24 +02:00
Miss Islington (bot)
a3ca6747f5
bpo-14014: Clarify StreamWriter.reset() documentation (GH-13716)
(cherry picked from commit 1a9f51ed12)

Co-authored-by: Berker Peksag <berker.peksag@gmail.com>
2021-01-06 04:27:30 +02:00
Julien Palard
e6d0107e13
Revert "[3.9] [doc] Fix erroneous backslashes in signatures and names (GH-23658)" (GH-24092)
This partially reverts commit
e89993cff4, which was removing
backslashes in documentations compiled with Sphinx < 3, used for
Python 3.8 and 3.9 docs.
2021-01-04 17:19:27 +01:00
Serhiy Storchaka
b0ee2b492d
[3.9] bpo-42681: Fix range checks for color and pair numbers in curses (GH-23874). (GH-24077)
(cherry picked from commit 1470edd613)
2021-01-04 00:55:23 +02:00
Miss Islington (bot)
8333d421c0
bpo-42781: Document the mechanics of cached_property from a user viewpoint (GH-24031) (#24035) 2020-12-31 17:36:14 -08:00
Miss Islington (bot)
55fadffb0b
Fixes a typo in importlib.metadata. (GH-23921) (#24029)
Signed-off-by: Tao He <sighingnow@gmail.com>
(cherry picked from commit 3631d6deab)

Co-authored-by: Tao He <sighingnow@gmail.com>

Co-authored-by: Tao He <sighingnow@gmail.com>
2020-12-31 12:27:17 -08:00
Andre Delfino
7a7f3e0d6a
[3.9] bpo-41224: Add versionadded for Symbol.is_annotated (GH-23861). (GH-24017)
(cherry picked from commit 2edfc86f69)
2020-12-31 15:10:10 +02:00