Commit graph

10536 commits

Author SHA1 Message Date
Miss Islington (bot)
049e98b2b7
[3.9] bpo-43958: Document importlib.metadata.PackagePath.locate method (GH-25669) (GH-27221)
(cherry picked from commit b38b2fa021)


Co-authored-by: Paul Moore <p.f.moore@gmail.com>

Automerge-Triggered-By: GH:jaraco
2021-07-17 19:53:00 -07:00
Miss Islington (bot)
421b543311
bpo-44639: fix typo in sqlite.rst (transation => transaction) (GH-27145) (GH-27149)
To my understanding, this is supposed to say "transaction".

See the relevant source:

a158b20019/Modules/_sqlite/connection.cGH-L1434-L1467
(cherry picked from commit 1ca27f2647)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-07-14 23:49:33 +01:00
Miss Islington (bot)
a3d20bfee3
bpo-43126: Expand docs on io.IOBase.readlines() method (GH-27061) (#27114)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 3b5b99da4b)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-07-13 16:41:31 +02:00
Miss Islington (bot)
105e6cd67c
bpo-44514: Add doctest testcleanup for configparser and bz2 (GH-26909) (#27111)
Add testcleanup section to configparser and bz2 documentation which
removes temporary files created in the filesystem when 'make doctest'
is run.
(cherry picked from commit 48a5aa7f12)

Co-authored-by: Kevin Follstad <kfollstad@gmail.com>
2021-07-13 16:33:50 +02:00
Miss Islington (bot)
c786988b19
bpo-42194: Add "New in version: 3.9" to argparse.BooleanOptionalAction (GH-23026) (#27098)
(cherry picked from commit da2e673c53)

Co-authored-by: David Sanders <shang.xiao.sanders@gmail.com>
2021-07-12 18:23:25 +02:00
Miss Islington (bot)
47abf24036
bpo-26329: update os.path.normpath documentation (GH-20138) (#27095)
(cherry picked from commit 66c5853406)

Co-authored-by: Furkan Onder <furkanonder@protonmail.com>
2021-07-12 17:22:33 +02:00
Miss Islington (bot)
779983ed7f
bpo-43207: InspectLoader.is_package is not an abstract method (GH-24517) (#26322)
Making the description of `InspectLoader.is_package` aligned with the current implementation.

Automerge-Triggered-By: GH:jaraco
(cherry picked from commit 8b9310d902)

Co-authored-by: Junnosuke Kuroda <Isa-rentacs@users.noreply.github.com>
2021-07-12 17:11:59 +02:00
Steve Dower
863e3d5c7e
bpo-41180: Replace marshal code.__new__ audit event with marshal.load[s] and marshal.dumps (GH-26971) 2021-06-30 18:52:39 +01:00
Miss Islington (bot)
02859df105
bpo-38062: [doc] clarify that atexit uses equality comparisons internally. (GH-26935) (GH-26957)
(cherry picked from commit 12803c59d5)

Co-authored-by: Jack DeVries <58614260+jdevries3133@users.noreply.github.com>
2021-06-29 18:53:07 +01:00
Miss Islington (bot)
3ba65cdcef
bpo-42588: Update the docs for the TopologicalSorter.static_order() method (GH-26834) (GH-26952)
(cherry picked from commit 0d7f7975d5)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-06-29 15:19:05 +01:00
Jason R. Coombs
17b916737b
[3.9] bpo-37741: make importlib.metadata docs discoverable through a module directive. (GH-25415) (GH-26500)
Automerge-Triggered-By: GH:jaraco.
(cherry picked from commit 23acadcc1c)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
2021-06-27 18:05:27 -04:00
Miss Islington (bot)
ef89b2bf42
[doc] Improve punctuation atexit doc (GH-25629) (GH-26857)
(cherry picked from commit a6b47de07a)

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>

Co-authored-by: Géry Ogam <gery.ogam@gmail.com>
2021-06-22 18:10:50 +01:00
Miss Islington (bot)
a65df3f9fc
bpo-41621: Document defaultdict's default_factory parameter (GH-21945)
It defaults to None and is positional only.
(cherry picked from commit d1ae57027f)

Co-authored-by: Dennis Sweeney <36520290+sweeneyde@users.noreply.github.com>
2021-06-22 07:42:41 -07:00
Miss Islington (bot)
7f021952b2
bpo-38291: Remove mention of typing.io and typing.re again (GH-26113)
They were originally removed in GH-10173 per bpo-35089, but then
readded in GH-21574. Cf. bpo-38291 for decision to remove.
(cherry picked from commit 8a76683cfb)

Co-authored-by: Sebastian Rittau <srittau@rittau.biz>
2021-06-14 08:07:05 -07:00
Terry Jan Reedy
d5f8bd60e1
[3.9] bpo-44322: Document more SyntaxError details. (GH-26562)
1. SyntaxError args have a tuple of other attributes.
2. Attributes are adjusted for errors in f-string field expressions.
3. Compile() can raise SyntaxErrors.

(cherry picked from commit 67dfa6f2a5)
2021-06-06 22:57:53 -04:00
Miss Islington (bot)
ea298e1e33
bpo-44279: revert 'exceptions are raised' back to 'exceptions occur' (GH-26492) (GH-26539)
(cherry picked from commit dda9ecbfec)

Co-authored-by: Irit Katriel <1055913+iritkatriel@users.noreply.github.com>
2021-06-04 23:09:45 +01:00
Irit Katriel
9a68862497
[3.9] bpo-44279: [doc] reword contextlib.suppress documentation (GH-26428) (GH-26481)
(cherry picked from commit 87272b70f1)

Co-authored-by: MapleCCC <littlelittlemaple@gmail.com>
2021-06-01 23:15:48 +01:00
Miss Islington (bot)
bee66d3cb9
bpo-41147: [doc] contextlib.redirect_stdout() provides the new stream as context var (GH-21199) (GH-26380)
(cherry picked from commit 46db39d7bd)

Co-authored-by: Peter Law <PeterJCLaw@gmail.com>
2021-05-26 15:43:37 +01:00
Miss Islington (bot)
8accb8c8cc
bpo-20408: Fix memoryview() signature in docs (GH-24431)
(cherry picked from commit d18e5dae91)

Co-authored-by: Mariusz Felisiak <felisiak.mariusz@gmail.com>
2021-05-25 17:30:42 +03:00
Miss Islington (bot)
ab4da07923
[3.9] bpo-44195: Use 'TraversableResources' in the docs to match the implementation. (GH-26317) (GH-26335)
(cherry picked from commit 7148293d96)


Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

Automerge-Triggered-By: GH:jaraco
2021-05-24 10:33:03 -07:00
Mariusz Felisiak
b21193dd1e
[3.9] Remove duplicate words in docs. (GH-26167) (GH-26297)
(cherry picked from commit b06ed1d883)
2021-05-22 21:56:19 +01:00
Miss Islington (bot)
11b5045b0c
bpo-8264: Document hasattr and getattr behavior for private attributes (GH-23513) (GH-26238)
Clarify ``getattr`` and ``setattr`` requirements for accessing name-mangled attributes

Co-Authored-By: Catalin Iacob <iacobcatalin@gmail.com>
(cherry picked from commit 2edaf6a4fb)

Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
2021-05-22 12:06:46 +01:00
Miss Islington (bot)
a373c80811
Specify Python Cookbook edition for reference (GH-26301) (#26303)
(cherry picked from commit 604cd71e50)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-05-21 23:48:31 +01:00
Zackery Spytz
96c9961bfe
bpo-43556: Fix the attr names for ast.expr and ast.stmt in the docs (GH-24940) 2021-05-21 21:29:12 +01:00
Miss Islington (bot)
bcd59134f5
[doc] Fix indentation in inspect documentation (GH-24846) (GH-26288)
(cherry picked from commit 642fdfdc04)

Co-authored-by: Numerlor <25886452+Numerlor@users.noreply.github.com>
2021-05-21 18:06:58 +01:00
Miss Islington (bot)
dc6526dfa2
[doc] Fix typo in asyncio-eventloop documentation (GH-22311) (GH-26257)
(cherry picked from commit b66a03a491)

Co-authored-by: Bruno <brunogeninatti@gmail.com>
2021-05-19 22:20:10 +01:00
Miss Islington (bot)
ab1c3d99f5
bpo-37741: make importlib.metadata docs discoverable through a module directive. (GH-25415) (GH-25417)
Automerge-Triggered-By: GH:jaraco
(cherry picked from commit 23acadcc1c)

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
2021-05-19 17:06:55 -04:00
Miss Islington (bot)
9a75cc6044
bpo-40975: [doc] Identify AsyncExitStack.enter_async_context()/aclose() as coroutine methods (GH-20870) (GH-26255)
(cherry picked from commit c054e8f78f)

Co-authored-by: naglis <naglis@users.noreply.github.com>
2021-05-19 21:37:52 +01:00
Miss Islington (bot)
76ed53ca7b
bpo-30593: Doc'ed that executescript() disregards isolation level (GH-26220)
(cherry picked from commit 9014437573)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-05-19 10:32:45 +03:00
Ken Jin
632b4034ab
[3.9] bpo-42783: Documentation for asyncio.sleep(0) (GH-24002) (GH-24153)
Co-Authored-By: Simon Willison <swillison@gmail.com>
2021-05-18 23:31:27 +01:00
Miss Islington (bot)
c17ba233b3
bpo-41963: document that ConfigParser strips off comments (GH-26197) (GH-26213)
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
Co-authored-by: Laura Gutierrez Funderburk <58710704+lgfunderburk@users.noreply.github.com>
Co-authored-by: Jürgen Gmach <juergen.gmach@googlemail.com>

(cherry picked from commit 02ee819126)
2021-05-18 18:44:48 +02:00
Miss Islington (bot)
2f9ebe6fd0
[doc] Fix typo in os module (GH-24464)
Automerge-Triggered-By: GH:iritkatriel
(cherry picked from commit fdc7e52f5f)

Co-authored-by: Rafael Fontenelle <rffontenelle@users.noreply.github.com>
2021-05-16 17:00:12 -07:00
Miss Islington (bot)
376740110e
bpo-32133: Improve numbers docs (GH-26124) (GH-26147) 2021-05-15 10:28:05 -07:00
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