Commit graph

10477 commits

Author SHA1 Message Date
Miss Islington (bot)
cf9d65c5af
bpo-37751: Update codecs.register() doc. (GH-25643)
(cherry picked from commit 5c84bb506a)

Co-authored-by: Inada Naoki <songofacandy@gmail.com>
2021-04-28 11:26:11 +09:00
Miss Islington (bot)
4a3d73d8ad
[doc] Remove duplicated operator.itemgetter example (GH-24178) (#25646)
* Remove duplicated itemgetter example
* Add spaces
(cherry picked from commit 743e2bae10)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-04-26 21:16:40 -07:00
Miss Islington (bot)
c816c1c779
Use the zero argument form of super() in examples for Python3 docs. (GH-22314) (GH-25638)
(cherry picked from commit 52cd6d5e1b)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-04-26 15:16:20 -07:00
Miss Islington (bot)
c9c1dbd253
bpo-43938: improve dataclasses.FrozenInstanceError documentation (GH-25603) (GH-25635)
(cherry picked from commit 8a307e488d)

Co-authored-by: Llandy Riveron Del Risco <llandy3d@gmail.com>

Co-authored-by: Llandy Riveron Del Risco <llandy3d@gmail.com>
2021-04-26 15:36:23 -04:00
Miss Islington (bot)
b348580da6
Doc: Fix the array.fromfile method doc (GH-22037) (GH-25630)
The check about the f argument type was removed in this commit:
2c94aa567e

Thanks for Pedro Arthur Duarte (pedroarthur.jedi at gmail.com) by the help with
this bug.
(cherry picked from commit bd25bcd37a)

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>

Co-authored-by: Adorilson Bezerra <adorilson@gmail.com>
2021-04-26 07:24:17 -07:00
Miss Islington (bot)
d7a1a815d9
Update asyncio-subprocess.rst (GH-21680) (GH-25621)
(cherry picked from commit 3c4850e222)

Co-authored-by: Gabriel R F <github@gabrf.com>
2021-04-25 21:47:05 -07:00
Senthil Kumaran
debb23fae6
[3.9] documentation: clarification about the function remove in os library (GH-19024) (GH-25620)
(cherry picked from commit b6daab2f67)

Co-authored-by: Etienne Gautier <etienne.gautier@outlook.com>
2021-04-25 21:30:32 -07:00
Miss Islington (bot)
4cb98169b3
Fix documentation typos of argparse exit_on_error (GH-22706) (GH-25617)
(cherry picked from commit 7be870f945)

Co-authored-by: Taneli Hukkinen <hukkinj1@users.noreply.github.com>
2021-04-25 21:06:55 -07:00
Miss Islington (bot)
7349c12452
Fix id of 'Internet Message Format' RFC in email doc GH-25613
Previous ID (5233) refers to "Sieve Email Filtering: Subaddress
Extension". It seems that the actual reference should be "Internet
Message Format" RFC 5322 (https://tools.ietf.org/html/rfc5322).

(The typo probably comes from commit 29d1bc0842 in which the ID of
this RFC got updated from the obsolete 2822.)

Co-authored-by: Ambrose Chua <ambrose@hey.com>
(cherry picked from commit cb5c802dcf)
Co-authored-by: Denis Laxalde <denis@laxalde.org>
2021-04-25 18:42:56 -07:00
Miss Islington (bot)
b861ed1006
Fix copy.Error casing in documentation GH-22004 (#25611)
(cherry picked from commit 0d930f108c)

Co-authored-by: Andre Delfino <adelfino@gmail.com>

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-04-25 18:39:24 -07:00
Miss Islington (bot)
9b2c5b20a5
Remove mention of dst parameter from description of os.lstat() (GH-24704)
It looks like it was accidentally copy-pasted in
6fa7aada9b.
(cherry picked from commit 7f8e072c6d)

Co-authored-by: Sergey Fedoseev <fedoseev.sergey@gmail.com>
2021-04-25 14:47:54 -07:00
Miss Islington (bot)
2825f906c7
BaseHTTPRequestHandler, that path includes query (GH-25597)
* Clarify, for BaseHTTPRequestHandler, that path includes query

Co-authored-by: David Jones <drj@pobox.com>
(cherry picked from commit a89d8a94a0)

Co-authored-by: Senthil Kumaran <senthil@uthcode.com>
2021-04-25 10:30:15 -07:00
Miss Islington (bot)
52e9031fbd
bpo-43284: Update platform.win32_ver to use _syscmd_ver instead of sys.getwindowsversion() (GH-25500)
The sys module uses the kernel32.dll version number, which can vary from the "actual" Windows version.
Since the best option for getting the version is WMI (which is expensive), we switch back to launching cmd.exe (which is also expensive, but a lot less code on our part).
sys.getwindowsversion() is not updated to avoid launching executables from that module.
(cherry picked from commit 2a3f4899c6)

Co-authored-by: Shreyan Avigyan <shreyan.avigyan@gmail.com>
2021-04-23 19:09:20 +01:00
Jason R. Coombs
d4fff1f580
bpo-43856: Add a versionadded directive to the importlib.metadata docs (GH-25445)
Use a versionadded directive to generate the text "New in version
3.8." (to match with the documentation of other modules).

Automerge-Triggered-By: GH:jaraco.
(cherry picked from commit adf24bd835)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2021-04-23 15:46:16 +09:00
Miss Islington (bot)
87a392db40
bpo-28724: Doc: Move socket.send_fds and socket.recv_fds docs to right section (GH-22608)
(cherry picked from commit 660592f67c)

Co-authored-by: Saiyang Gou <gousaiyang@163.com>
2021-04-21 21:32:40 -07:00
Christian Heimes
cdf0287979
[3.9] bpo-43522: Fix SSLContext.hostname_checks_common_name (GH-24899) (GH-25451)
Fix problem with ssl.SSLContext.hostname_checks_common_name. OpenSSL does not
copy hostflags from *struct SSL_CTX* to *struct SSL*.

Signed-off-by: Christian Heimes <christian@python.org>.
(cherry picked from commit b467d9a240)

Co-authored-by: Christian Heimes <christian@python.org>
2021-04-17 11:35:24 +02:00
Terry Jan Reedy
56c76df6e8
[3.9] bpo-43723: Revert IDLE doc change (GH-25174)
Change threading.activeCount to synonym threading.active_count.
2021-04-16 02:08:07 -04:00
Miss Islington (bot)
95e4431804
bpo-20364: Improve sqlite3 placeholder docs (GH-25003)
(cherry picked from commit 3386ca0b36)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-04-14 16:28:11 +03:00
Miss Islington (bot)
de06baa9de
bpo-41661: Document os.path.relpath() exception on Windows with different drives (GH-25346)
(cherry picked from commit 67c0b3d89c)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2021-04-12 09:03:08 -07:00
Miss Islington (bot)
7c8796a750
bpo-38820: OpenSSL 3.0.0: Use supported hashing algos in doc test (GH-25319)
ripemd160 is not available in OpenSSL 3.0.0's default crypto provider.
It's only present in legacy provider.

Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit 2d7fdc9073)

Co-authored-by: Christian Heimes <christian@python.org>
2021-04-09 13:46:17 -07:00
Miss Islington (bot)
54d89a33e0
bpo-43794: OpenSSL 3.0.0: set OP_IGNORE_UNEXPECTED_EOF by default (GH-25309)
Signed-off-by: Christian Heimes <christian@python.org>
(cherry picked from commit 6f37ebc61e)

Co-authored-by: Christian Heimes <christian@python.org>
2021-04-09 09:21:54 -07:00
Miss Islington (bot)
5490b49fa6
[3.9] bpo-43087: Fix error in ctypes "Incomplete Types" doc (GH-24404)
The previous "Fundamental data types" section says a c_char_p must be bytes (or None).
(cherry picked from commit 14829b09eb)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2021-04-08 04:21:35 -04:00
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