Commit graph

10503 commits

Author SHA1 Message Date
Miss Islington (bot)
fa9de0c383
bpo-44072: fix Complex, Integral docs for ** (GH-25986)
In numbers module docstrings and docs.
(cherry picked from commit 4aa63d65a9)

Co-authored-by: Rory Yorke <rory.yorke@gmail.com>
2021-05-14 15:25:43 -07:00
Miss Islington (bot)
41ed452a91
Subprocess Protocols Documentation (GH-20950) (GH-26134)
Should be "Subprocess Protocol instances" not "Datagram Protocol instances"
(cherry picked from commit 2918846a4f)

Co-authored-by: kudavid <67070184+kudavid@users.noreply.github.com>

Co-authored-by: kudavid <67070184+kudavid@users.noreply.github.com>
2021-05-14 10:23:03 -07:00
Miss Islington (bot)
9bc96c0146
[doc] Fix typos in cgi.rst (GH-24766) (GH-26131)
(cherry picked from commit 19d839ae20)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2021-05-14 18:13:40 +01:00
Miss Islington (bot)
f38296feaa
Updated code example for asyncio.gather (GH-20604) (GH-26120)
The previous example did not fully showcase the interest of using gather.

Here the example showcases "the result is an aggregate list of returned values".
(cherry picked from commit 56b8ea65d2)

Co-authored-by: josephernest <nouvellecollection@gmail.com>

Co-authored-by: josephernest <nouvellecollection@gmail.com>
2021-05-13 23:07:31 -07:00
Miss Islington (bot)
c9049cf0aa
bpo-10548: expectedFailure does not apply to fixtures (GH-23201) (#26045)
(cherry picked from commit 23ae2c3bac)

Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
2021-05-11 23:23:54 +01:00
Miss Islington (bot)
390bfe0445
bpo-23750: Document os-system, subprocess. Patch by Martin Panter. (GH-26016) (GH-26041)
* Document os-system, subprocess Patch

* Update Doc/library/os.rst

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

Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 5f2eb87f28)

Co-authored-by: uniocto <serit142sa33go@gmail.com>

Co-authored-by: uniocto <serit142sa33go@gmail.com>
2021-05-11 13:55:24 -07:00
Miss Islington (bot)
bde14f7fbd
bpo-25821: Fix inaccuracy in threading.enumerate/is_alive documentation (GH-23192) (#26036)
(cherry picked from commit 12e7d10dfd)

Co-authored-by: Irit Katriel <iritkatriel@yahoo.com>
2021-05-11 19:19:42 +01:00
Miss Islington (bot)
1d8c18019d
Doc: http.server: directory is not a class attribute, but an argument. (GH-26017) (GH-26030)
* Doc: http.server: directory is not a class attribute, but an argument.
(cherry picked from commit d1b81574ed)

Co-authored-by: Julien Palard <julien@palard.fr>

Co-authored-by: Julien Palard <julien@palard.fr>
2021-05-10 18:59:22 -07:00
Miss Islington (bot)
4d532d3f8f
bpo-43558: Add note about base class initialization to dataclasses doc (GH-25967) (GH-26019)
(cherry picked from commit 2a031723ee)

Co-authored-by: dhoekstra2000 <douwe.hoekstra2512@gmail.com>

Co-authored-by: dhoekstra2000 <douwe.hoekstra2512@gmail.com>
2021-05-10 09:38:01 -04:00
Miss Islington (bot)
bf309d74a5
Simple Enhancement. Add missing return statements in ftplib documentation. (GH-25968) (#25970)
(cherry picked from commit b32c8e9795)

Co-authored-by: Senthil Kumaran <senthil@uthcode.com>

Co-authored-by: Senthil Kumaran <senthil@uthcode.com>
2021-05-07 07:13:19 -07:00
Miss Islington (bot)
7424105a02
Fix minor grammar problems in dataclasses documentation (GH-25948) (#25959)
Some missing words; some odd word choices.
(cherry picked from commit ee8e7c2fa9)

Co-authored-by: Scott Noyes <snoyes@gmail.com>

Co-authored-by: Scott Noyes <snoyes@gmail.com>
2021-05-06 17:54:58 -04:00
Miss Islington (bot)
1326f51bfc
docs: clearly document that ":GH-X" string formatting results in "0X..." (GH-25941)
* clearly document that ":GH-X" string formatting results in "0X..."

* put back the "serial comma"
(cherry picked from commit 92ceb1c840)

Co-authored-by: Tal Einat <532281+taleinat@users.noreply.github.com>
2021-05-06 12:52:50 -07:00
Miss Islington (bot)
8faed45242
Clarify rx parameter of compileall functions (GH-25857)
(cherry picked from commit 09490298d4)

Co-authored-by: Jean-Abou-Samra <37271310+Jean-Abou-Samra@users.noreply.github.com>
2021-05-04 12:59:45 -07:00
Jelle Zijlstra
ab0a54adad
[3.9] bpo-44001: improve Literal documentation (GH-25877). (#25897)
(cherry picked from commit 87109f4d85)

Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2021-05-04 18:48:41 +02:00
Miss Islington (bot)
4b90c8f176
closes bpo-43349: Fix tuning(7) manpage hyperlink. (GH-24680) (#25694)
(cherry picked from commit f4d7d46cb4)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-05-04 15:48:24 +02:00
Steve Dower
bb2f3ff7a8
bpo-42800: Add audit events for f_code and tb_frame (GH-24182)
Accessing the following attributes will now fire PEP 578 style audit hooks as (object.__getattr__, obj, name):
* PyTracebackObject: tb_frame
* PyFrameObject: f_code
* PyGenObject: gi_code, gi_frame
* PyCoroObject: cr_code, cr_frame
* PyAsyncGenObject: ag_code, ag_frame
2021-05-03 14:06:36 +01:00
Miss Islington (bot)
1536342c44
[3.9] Doc: Fix random.uniform example comment. (GH-25784) (GH-25843)
(cherry picked from commit 440c025726)


Co-authored-by: Julien Palard <julien@palard.fr>

Automerge-Triggered-By: GH:JulienPalard
2021-05-03 05:43:04 -07:00
Miss Islington (bot)
5374fbc314
bpo-36384: Leading zeros in IPv4 addresses are no longer tolerated (GH-25099) (GH-25815)
Reverts commit e653d4d8e8 and makes
parsing even more strict. Like socket.inet_pton() any leading zero
is now treated as invalid input.

Signed-off-by: Christian Heimes <christian@python.org>

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 60ce8f0be6)
2021-05-02 15:49:03 +02:00
Miss Islington (bot)
10a62bbecc
Fix exceptions mentioned in os.setxattr() docs (GH-25742) (GH-25794)
(cherry picked from commit 779232413a)

Co-authored-by: Shreyash Sharma <shreyash.sharma@philips.com>

Co-authored-by: Shreyash Sharma <shreyash.sharma@philips.com>
2021-05-01 16:56:05 -04:00
Miss Islington (bot)
5c018db467
Fixing doc for callback for lambda (GG-25779) (GH-25788)
Fixing callback for lambda when no return value is provided
(cherry picked from commit 50c21ad353)

Co-authored-by: Shreyash Sharma <shreyash.sharma@philips.com>

Co-authored-by: Shreyash Sharma <shreyash.sharma@philips.com>
2021-05-01 15:55:46 -04:00
Miss Islington (bot)
e48405a9be
bpo-43971: Add spaces around annotated arg default '=' (GH-25702)
Result: "quantity_on_hand: int = 0".
(cherry picked from commit e726a902b7)

Co-authored-by: Mohamed Moselhy <look4d@gmail.com>

Co-authored-by: Mohamed Moselhy <look4d@gmail.com>
2021-04-30 20:30:38 -04:00
Miss Islington (bot)
a92d738763
bpo-43954: Fix a missing word in the unittest docs (GH-25672)
(cherry picked from commit 2abbd8f2ad)

Co-authored-by: Zackery Spytz <zspytz@gmail.com>
2021-04-30 00:56:56 -07:00
Miss Islington (bot)
3eaa6f9d18
bpo-42589: Change URL for 'from' link when used in a raised exception (GH-23872)
Links for 'raise Exception from x' target to 'The raise statement' (7.8) section instead of 'The import statement' (7.11) section.

There are more modified links than in the bug report because I searched some other ones which can get the same improvement.
(cherry picked from commit 2fd928c8c1)

Co-authored-by: sblondon <sblondon@users.noreply.github.com>
2021-04-29 11:26:26 -07:00
Miss Islington (bot)
491fde0161
[3.9] bpo-43882 - urllib.parse should sanitize urls containing ASCII newline and tabs. (GH-25595) (GH-25725)
* bpo-43882 - urllib.parse should sanitize urls containing ASCII newline and tabs. (GH-25595)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit 76cd81d603)
Co-authored-by: Senthil Kumaran <skumaran@gatech.edu>
2021-04-29 10:57:31 -07:00
Miss Islington (bot)
8d47f92d46
[doc] Be more clear on super() regarding multiple base classes methods (GH-21789) (GH-25706)
(cherry picked from commit 69a733bda3)

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

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-04-28 18:13:12 -07:00
Miss Islington (bot)
0252ce3571
bpo-43472: Ensure PyInterpreterState_New audit events are raised when called through _xxsubinterpreters module (GH-25506) (GH-25508)
(cherry picked from commit 7b86e47617)

Co-authored-by: Steve Dower <steve.dower@python.org>

Co-authored-by: Steve Dower <steve.dower@python.org>
2021-04-28 18:20:40 +02:00
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