Commit graph

24437 commits

Author SHA1 Message Date
Miss Islington (bot)
75ed2ce9e8
Remove reference to `Tuple at top of typing` docs (GH-29401)
``typing.Tuple`` has been deprecated since Python 3.9, so it makes no sense to mention it so prominently in the documentation for the ``typing`` module.
(cherry picked from commit 87032cfa3d)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-04 05:11:14 -07:00
Miss Islington (bot)
c10896696f
bpo-45680: `typing docs: improve links to docs on GenericAlias/__class_getitem__` (GH-29387)
(cherry picked from commit e03e50377d)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-11-03 21:27:47 -07:00
Miss Islington (bot)
0624706179
bpo-45633: Fix newtypes doc typo (GH-29318) (GH-29364)
(cherry picked from commit 454cdb99ab)

Co-authored-by: Dmitry Smirnov <dmitrysmirnov931@gmail.com>
2021-11-03 17:30:02 +08:00
Miss Islington (bot)
8af3090cb7
[doc] Link to section File input (GH-28941) (GH-29375)
(cherry picked from commit 48824fa1e2)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-11-02 22:54:53 +01:00
Miss Islington (bot)
71f602b54c
bpo-45457: Minor fix to documentation for SSLContext.load_default_certs. (GH-28947) (GH-29373)
Specify that SSLContext.set_default_verify_paths is called on ALL systems.

The code of SSLContext.load_default_certs was changed in bpo-22449 to do this,
this fix corrects the documentation to match that change.
(cherry picked from commit 3551bf16ee)

Co-authored-by: LincolnPuzey <lincoln@puzey.dev>
2021-11-02 22:47:50 +01:00
Miss Islington (bot)
ed34965d66
[3.10] Move field width to the right field (GH-29344) (GH-29351)
Co-authored-by: Olaf van der Spek <olafvdspek@gmail.com>
2021-10-31 20:25:44 +00:00
Miss Islington (bot)
89b1237ffb
bpo-45516: add protocol description to the Traversable documentation (GH-29039)
* bpo-45516: add protocol description to the Traversable documentation

Signed-off-by: Filipe Laíns <lains@riseup.net>

* Update Doc/library/importlib.rst

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

* Update Lib/importlib/abc.py

* Update Doc/library/importlib.rst

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

Co-authored-by: Jason R. Coombs <jaraco@jaraco.com>
(cherry picked from commit 4d03de3329)

Co-authored-by: Filipe Laíns <filipe.lains@gmail.com>
2021-10-31 12:26:49 -07:00
Miss Islington (bot)
da222b7cc8
Fix docs source link for importlib.metadata (GH-29025)
The link broke for Python 3.10 since importlib.metadata was made from a module into a package

I think this is trivial enough to not need a bpo issue.

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

Co-authored-by: Philipp A <flying-sheep@web.de>
2021-10-30 08:32:14 -07:00
Miss Islington (bot)
0538351fca
bpo-45600: Enhanced / clarified the docs for os.environ and os.environb (GH-29204) (GH-29322)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b17cfd150f)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-10-29 22:45:33 +02:00
Miss Islington (bot)
8ea665c730
bpo-45335: Add note to sqlite3 docs about "timestamp" converter (GH-29200) (GH-29319)
(cherry picked from commit 3877fc02f7)

Co-authored-by: Ian Fisher <ian@iafisher.com>
2021-10-29 22:41:45 +02:00
Miss Islington (bot)
6742b0dfb6
bpo-45655: Add ref to union type expressions at top of typing docs (GH-29309)
(cherry picked from commit d9575218d7)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-10-29 07:16:19 -07:00
Alex Waygood
2c8a0027e5
[3.10] bo-45655: Add "relevant PEPs" section to typing documentation (GH-29302)
The list of PEPs at the top of the documentation for the ``typing`` module has
become too long to be readable. This PR proposes presenting this
information in a more structured and readable way by adding a new "relevant
PEPs" section to the ``typing`` docs.

(cherry picked from commit 03db1bbfd2)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-29 18:03:48 +08:00
Miss Islington (bot)
fef54abf5f
bpo-45583: Correct datamodel documentation of int() (GH-29182) (GH-29285)
It should be noted that this part of the documentation is redundant with
function.rst's documentation of int. This one was correctly updated with Python 3.8.
(cherry picked from commit d9c1868c25)

Co-authored-by: Arthur Milchior <arthur@milchior.fr>
2021-10-28 22:17:06 +02:00
Miss Islington (bot)
fb80aede6a
bpo-45604: add level argument to multiprocessing.log_to_stderr func (GH-29226) (GH-29283)
Co-authored-by: blurb-it[bot] <43283697+blurb-it[bot]@users.noreply.github.com>
(cherry picked from commit 1fb968c07a)

Co-authored-by: Nikita Sobolev <mail@sobolevn.me>
2021-10-28 21:58:24 +02:00
Miss Islington (bot)
1d88b2b0a1
bpo-45608: Document missing sqlite3 DB-API attributes and methods (GH-29219) (GH-29281)
(cherry picked from commit 88d8a1a340)

Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
2021-10-28 21:57:14 +02:00
Sam Gross
9e0012116a
[3.10] bpo-28737: Document when tp_dealloc should call PyObject_GC_UnTrack() (GH-29246) (GH-29249)
Objects that support garbage collection ("container" objects) should
call PyObject_GC_UnTrack() from their destructors before clearing any
fields which may point to other "container" objects.
(cherry picked from commit 35e1ff38ee)

Co-authored-by: Sam Gross <colesbury@gmail.com>
2021-10-28 21:22:57 +02:00
Miss Islington (bot)
99495b8aff
Fix typo in Counter documentation (GH-29223)
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
(cherry picked from commit 0a68b3603f)

Co-authored-by: Justinas Petuchovas <justinas.petuchovas@gmail.com>
2021-10-28 04:06:04 -07:00
Miss Islington (bot)
2b7b7c7320
bpo-45618: Fix documentation build by pinning Docutils version to 0.17.1 (GH-29230) (GH-29240)
Co-authored-by: Maciej Olko <maciej.olko@yougov.com>
Co-authored-by: Erlend Egeberg Aasland <erlend.aasland@innova.no>
(cherry picked from commit bcee6aa315)
2021-10-27 10:37:17 -04:00
Miss Islington (bot)
9b3cda5687
bpo-44344: Document that pow can return a complex number for non-complex inputs. (GH-27853) (GH-29135)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 887a55705b)

Co-authored-by: Mark Dickinson <mdickinson@enthought.com>
2021-10-22 00:08:20 +02:00
Miss Islington (bot)
8fd7e8965d
bpo-41983: add availability info to socket docs (GH-27519) (GH-29136)
* add availability info to AF_PACKET section
* add availability for AF_QIPCRTR as well

(cherry picked from commit 51375388be)

Co-authored-by: andrei kulakov <andrei.avk@gmail.com>
2021-10-22 00:07:07 +02:00
Ethan Furman
828722aca4
[3.10] bpo-44174: [Enum] add reference to name mangling (GH-29117) 2021-10-21 09:50:29 -07:00
Miss Islington (bot)
00ddc1fbd7
bpo-34451: Document prompt and output toggle feature in html tutorial (GH-27105) (GH-29119)
(cherry picked from commit 5a14f71fe8)

Co-authored-by: Thomas <thmsdnnr@gmail.com>
2021-10-21 14:41:32 +02:00
Ethan Furman
2a9ab75af3
bpo-44559: [Enum] restore fixes lost in 3.9 reversion (GH-29114)
- fix exception leaks
- re-add deprecation warnings
2021-10-20 19:48:37 -07:00
Miss Islington (bot)
b2a989995e
bpo-45464: [doc] Explain that subclassing multiple exceptions is fragile (GH-29094) (GH-29104)
Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
(cherry picked from commit dff0b71343)

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-20 20:50:09 +02:00
Miss Islington (bot)
0d0312e1ac
Add PEPs 593 & 647 to list of PEPs at top of typing docs (GH-29097)
(cherry picked from commit d9e1dae35a)

Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
2021-10-20 08:36:34 -07:00
Miss Islington (bot)
092ec4b9d1
bpo-45449: add note about PEP 585 in collections.abc's documentation (GH-29047) (GH-29067)
Signed-off-by: Filipe Laíns <lains@riseup.net>

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7bafa0cf58)
2021-10-19 20:41:33 +02:00
Miss Islington (bot)
8cef526a87
bpo-45515: Add zoneinfo to the datetime documentation (GH-29038) (GH-29065)
We should have done this way back when 3.9 was released, but it fell off
the radar.

Co-authored-by: Paul Ganssle <git@m.ganssle.io>
(cherry picked from commit 8e40ca127f)
2021-10-19 20:35:34 +02:00
Miss Islington (bot)
7082abf53d
Improve multiserver queue recipe (GH-29012) (GH-29013) 2021-10-17 18:43:10 -05:00
Miss Islington (bot)
855d6247ad
[3.10]bpo-45463: Clarify that global statements allows multiple names (GH-28851) (GH-28989)
The global statement allows specifying a list of identifiers
(https://docs.python.org/3/reference/simple_stmts.htmlGH-the-global-statement).

The "Execution model" chapter described the global statement as if it
only allowed one single name. Pluralize "name" in the appropriate places.
(cherry picked from commit 4ecd119b00)

Co-authored-by: Luca Chiodini <luca@chiodini.org>

Co-authored-by: Luca Chiodini <luca@chiodini.org>
2021-10-16 10:01:54 -04:00
Serhiy Storchaka
4641afef66
[3.10] bpo-45467: Fix IncrementalDecoder and StreamReader in the "raw-unicode-escape" codec (GH-28944) (GH-28952)
They support now splitting escape sequences between input chunks.

Add the third parameter "final" in codecs.raw_unicode_escape_decode().
It is True by default to match the former behavior.
(cherry picked from commit 39aa98346d)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2021-10-14 21:23:39 +03:00
Miss Islington (bot)
0bff4ccbfd
[3.10] bpo-45461: Fix IncrementalDecoder and StreamReader in the "unicode-escape" codec (GH-28939) (GH-28943)
They support now splitting escape sequences between input chunks.

Add the third parameter "final" in codecs.unicode_escape_decode().
It is True by default to match the former behavior.
(cherry picked from commit c96d1546b1)

Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
2021-10-14 20:02:20 +03:00
Miss Islington (bot)
5abb2dec2c
[docs] lexical_analysis: Expand the text on `_` (GH-28903) (GH-28933)
Also:
* Expand the discussion into its own entry. (Even before this,
  text on ``_`` was longet than the text on ``_*``.)

* Briefly note the other common convention for `_`: naming unused
  variables.

Co-authored-by: Brandt Bucher <brandtbucher@gmail.com>
Co-authored-by: Ken Jin <28750310+Fidget-Spinner@users.noreply.github.com>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 3dee0cb621)

Co-authored-by: Petr Viktorin <encukou@gmail.com>
2021-10-13 18:58:06 +02:00
Miss Islington (bot)
47673c47db
bpo-20692: Add Programming FAQ entry for 1.__class__ error. (GH-28918)
To avoid error, add either space or parentheses.
(cherry picked from commit 380c440875)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-10-12 22:37:51 -07:00
Miss Islington (bot)
035ad8cf98
Slight correct grammar (GH-28860)
(cherry picked from commit 1b11582f0e)

Co-authored-by: nobodyatandnothing <91722596+nobodyatandnothing@users.noreply.github.com>
2021-10-12 10:01:11 -07:00
Miss Islington (bot)
32866dd471
bpo-45441: Update some moved URLs in documentation (GH-28861)
(cherry picked from commit b37dc9b3bc)

Co-authored-by: 180909 <wjh180909@gmail.com>
2021-10-12 07:20:43 -07:00
Miss Islington (bot)
3d7009e88e
bpo-42253: Update xml.dom.minidom.rst (GH-23126) (GH-28874)
Document that the "standalone" parameter was added in Python 3.9.
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit c7e81fcf95)

Co-authored-by: Jens Diemer <github.com@jensdiemer.de>
2021-10-12 10:17:53 +03:00
Miss Islington (bot)
bb4f885892
bpo-45351, asyncio: Enhance echo server example, print all addresses (GH-28828)
(cherry picked from commit 659812b451)

Co-authored-by: Olaf van der Spek <olafvdspek@gmail.com>
2021-10-11 12:34:47 -07:00
Miss Islington (bot)
aff69c34b0
Fix the "Finding all Adverbs" example (GH-21420) (#28839)
Co-authored-by: Serhiy Storchaka <storchaka@gmail.com>
(cherry picked from commit dbd62e74da)

Co-authored-by: Rim Chatti <chattiriim@gmail.com>
2021-10-10 14:43:38 -07:00
Miss Islington (bot)
3c27013077
Fix class pattern docs to refer to class patterns (GH-28849)
(cherry picked from commit 0bcc5ade9b)

Co-authored-by: Christophe Nanteuil <35002064+christopheNan@users.noreply.github.com>
2021-10-10 07:35:23 -07:00
Miss Islington (bot)
459a4db5ea
bpo-45353: Remind sys.modules users to copy when iterating. (GH-28842)
This is true of all dictionaries in Python, but this one tends to
catch people off guard as they don't realize when sys.modules might
change out from underneath them as a hidden side effect of their
code.  Copying it first avoids the RuntimeError.  An example when
this happens in single threaded code are codecs being loaded which
are an implicit time of use import that most need not think about.
(cherry picked from commit 3d1ca867ed)

Co-authored-by: Gregory P. Smith <greg@krypto.org>
2021-10-09 12:54:20 -07:00
Miss Islington (bot)
e086bfee03
Fix dataclassses spelling (GH-28837) (GH-28841)
(cherry picked from commit 5b4a7675bc)

Co-authored-by: Landon Yarrington <33426811+jly36963@users.noreply.github.com>

Co-authored-by: Landon Yarrington <33426811+jly36963@users.noreply.github.com>
2021-10-09 15:50:45 -04:00
Miss Islington (bot)
86bf45e69e
[3.10] Remove draft notice on the 3.10 What's new document (GH-28806) (GH-28807)
Automerge-Triggered-By: GH:pablogsal
(cherry picked from commit 32485cecab)


Co-authored-by: Pablo Galindo Salgado <Pablogsal@gmail.com>
2021-10-07 11:25:26 -07:00
Miss Islington (bot)
ee92205bb2
[3.10] Fix typo in whatsnew 3.10.rst (GH-26854) (GH-28782)
Thanks for the fix @wiggin15 .
(cherry picked from commit 599c07006a)


Co-authored-by: Arnon Yaari <wiggin15@yahoo.com>

Automerge-Triggered-By: GH:JulienPalard
2021-10-07 02:26:12 -07:00
Miss Islington (bot)
ce121fd875
[doc] Mention __slots__ behavior in weakref.rst (GH-21061) (GH-28772)
It took me longer than I expected to figure out why a random class
I dealt with didn't support weak references. I believe this addition
will make the __slots__/weakref interaction more discoverable to people
having troubles with this. (Before this patch __slots__ was not
mentioned in weakref documentation even once).

Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit b24b47e643)

Co-authored-by: Jakub Stasiak <jakub@stasiak.at>
2021-10-06 20:52:22 +02:00
Miss Islington (bot)
dcdeb96495
bpo-34804: [doc] Rephrase section on side effects in functional.rst for clarity (GH-27989) (GH-28762)
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
(cherry picked from commit 7af95a1e80)

Co-authored-by: DonnaDia <37962843+DonnaDia@users.noreply.github.com>
2021-10-06 17:15:42 +02:00
Christian Clauss
d15f47d179
[3.10] [doc] Fix typos found using codespell (GH-28744) (GH-28758) 2021-10-06 15:56:57 +02:00
Miss Islington (bot)
258c5fbbfd
sqlite3: Modernize documentation around unicode and bytes. (GH-28652) (GH-28694)
(cherry picked from commit 1dac95c814)

Co-authored-by: Julien Palard <julien@palard.fr>
2021-10-05 23:04:27 +02:00
Miss Islington (bot)
eb59e2fc11
[doc] Fix gethostbyname_ex description (GH-28700) (GH-28742)
It seems part of `gethostbyname_ex` doc was copied from `gethostbyaddr`. The latter has an `ip_address` parameter whereas the former doesn't.
(cherry picked from commit 4103280b83)

Co-authored-by: Andre Delfino <adelfino@gmail.com>
2021-10-05 19:21:25 +02:00
Miss Islington (bot)
72089f33c0
bpo-45346: Keep docs consistent regarding true and false values (GH-28697) (GH-28698) 2021-10-02 14:32:56 -05:00
Miss Islington (bot)
e040adc806
bpo-45341: Replace 'Packaging' with 'Package' in "Python P... Index" (GH-28687)
pypi.org "  The Python Package Index (PyPI) ...
(cherry picked from commit 0be338199f)

Co-authored-by: Terry Jan Reedy <tjreedy@udel.edu>
2021-10-01 23:27:23 -07:00