Stanislav Terliakov
56e4a417ce
gh-123523: Rework typing documentation for generators and coroutines, and link to it from `collections.abc` docs ( #123544 )
2024-09-06 17:41:06 +01:00
Nikita Sobolev
2f4db5a04d
gh-118803: Remove `ByteString` from `typing` and `collections.abc` ( #118804 )
2024-05-09 00:37:55 +01:00
Ned Batchelder
bcb435ee8f
docs: module page titles should not start with a link to themselves ( #117099 )
2024-05-08 20:34:40 +01:00
AN Long
b4240fd68e
gh-114955: Add clear to MutableSequence's mixin methods in document (gh-114956)
2024-02-03 09:33:58 -06:00
David Greaves
22b8945d76
Fix typo in collections.abc docs example ( #113310 )
...
Calling the instance reference arg for the __next__ method, "next", seems misleading as it would normally just be "self"
2023-12-20 09:51:16 +00:00
Alex Waygood
006355b2a9
gh-101100: Fix Sphinx nitpicks in `library/collections.abc.rst` ( #113116 )
2023-12-14 19:25:55 +00:00
Adam Turner
da99133710
GH-101100: Fix reference warnings for ``__getitem__`` ( #110118 )
2023-10-19 18:05:05 +03:00
Alex Waygood
c527eb1c2a
gh-91896: Revert some very noisy DeprecationWarnings for `ByteString` ( #104424 )
2023-05-13 09:55:35 +01:00
Alex Waygood
ce4eecf989
gh-91896: Fixup some docs issues following ByteString deprecation ( #104422 )
...
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2023-05-12 15:38:35 +01:00
Shantanu
09b7695f12
gh-91896: Deprecate collections.abc.ByteString ( #102096 )
...
Co-authored-by: Alex Waygood <Alex.Waygood@Gmail.com>
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
2023-05-04 09:39:33 -07:00
Jelle Zijlstra
b7a0a52196
gh-102500: Document PEP 688 ( #102571 )
...
Co-authored-by: Hugo van Kemenade <hugovk@users.noreply.github.com>
Co-authored-by: Shantanu <12621235+hauntsaninja@users.noreply.github.com>
2023-05-04 08:23:40 -07:00
Furkan Onder
3690688149
GH-101898: Fix missing term references for hashable definition ( #101899 )
...
Fix missing term references for hashable definition
2023-02-14 14:20:11 +04:00
Filipe Laíns
7bafa0cf58
bpo-45449: add note about PEP 585 in collections.abc's documentation (GH-29047)
...
Signed-off-by: Filipe Laíns <lains@riseup.net>
Co-authored-by: Łukasz Langa <lukasz@langa.pl>
2021-10-19 20:18:50 +02:00
Raymond Hettinger
62fa613f6a
bpo-45024 and bpo-23864: Document how interface testing works with the collections ABCs (GH-28218)
2021-09-09 21:51:07 -05:00
Illia Volochii
a1092f6249
bpo-43216: Remove @asyncio.coroutine (GH-26369)
...
Remove the @asyncio.coroutine decorator
enabling legacy generator-based coroutines to be compatible with async/await
code; remove asyncio.coroutines.CoroWrapper used for wrapping
legacy coroutine objects in the debug mode.
The decorator has been deprecated
since Python 3.8 and the removal was initially scheduled for Python 3.10.
2021-07-01 15:13:59 +02:00
Richard Levasseur
68f68fa423
Clarify that Set._from_iterable is not required to be a classmethod. (GH-23272)
2020-11-21 11:56:24 -08:00
Andre Delfino
e8a2076e14
Revert "Fix all Python Cookbook links ( #22205 )" (GH-22424)
...
This commit reverts commit ac0333e1e1
as the original links are working again and they provide extended features such as comments and alternative versions.
2020-09-27 01:47:25 +01:00
Andre Delfino
ac0333e1e1
Fix all Python Cookbook links ( #22205 )
2020-09-15 21:13:26 +01:00
Sydney Pemberton
2ce39631f6
bpo-40994: Ungroup items in collections.abc documentation for improved clarity (GH-21880)
...
Use a less surprising document structure.
Automerge-Triggered-By: @csabella
2020-08-20 03:30:21 -07:00
Victor Stinner
bb0b08540c
bpo-40204: Fix reference to terms in the doc (GH-21865)
...
Sphinx 3 requires to refer to terms with the exact case.
For example, fix the Sphinx 3 warning:
Doc/library/pkgutil.rst:71: WARNING: term Loader not found in case
sensitive match.made a reference to loader instead.
2020-08-14 12:20:05 +02:00
Raymond Hettinger
02556fbade
bpo-32467: Let collections.abc.ValuesView inherit from Collection ( #5152 )
2018-01-11 21:53:49 -08:00
Raymond Hettinger
0bf287b6e0
bpo-18558: Clarify glossary entry for "Iterable" ( #3732 )
2017-09-25 00:52:06 -07:00
Berker Peksag
61d9c8639e
Issue #28793 : Fix c/p error in AsyncGenerator documentation
...
Patch by Julien Palard.
2016-11-25 17:31:27 +03:00
Yury Selivanov
22214ab0af
Issue #28720 : Add collections.abc.AsyncGenerator.
2016-11-16 18:25:04 -05:00
Guido van Rossum
f0666949fd
Issue 27598: Add Collections to collections.abc.
...
Patch by Ivan Levkivskyi, docs by Neil Girdhar.
2016-08-23 10:47:07 -07:00
Guido van Rossum
97c1adf393
Anti-registration of various ABC methods.
...
- Issue #25958 : Support "anti-registration" of special methods from
various ABCs, like __hash__, __iter__ or __len__. All these (and
several more) can be set to None in an implementation class and the
behavior will be as if the method is not defined at all.
(Previously, this mechanism existed only for __hash__, to make
mutable classes unhashable.) Code contributed by Andrew Barnert and
Ivan Levkivskyi.
2016-08-18 09:22:23 -07:00
Brett Cannon
7365361408
Merge for #26696
2016-07-15 12:16:42 -07:00
Brett Cannon
9305bba203
Issue #26696 : Document collections.abc.ByteString.
...
Thanks to Xiang Zhang for the patch.
2016-07-15 12:16:18 -07:00
Terry Jan Reedy
4da945f361
Merge Issue #22558 .
2016-06-11 15:06:08 -04:00
Terry Jan Reedy
fa089b9b0b
Issue #22558 : Add remaining doc links to source code for Python-coded modules.
...
Reformat header above separator line (added if missing) to a common format.
Patch by Yoni Lavi.
2016-06-11 15:02:54 -04:00
Serhiy Storchaka
c499f30286
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:56 +03:00
Serhiy Storchaka
dba903993a
Issue #23921 : Standardized documentation whitespace formatting.
...
Original patch by James Edwards.
2016-05-10 12:01:23 +03:00
Serhiy Storchaka
1acbf853c8
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:58 +03:00
Serhiy Storchaka
6dff0205b7
Issue #26736 : Used HTTPS for external links in the documentation if possible.
2016-05-07 10:49:07 +03:00
Georg Brandl
d2be07e1fd
#25987 : add versionadded to Reversible.
2016-04-18 07:25:54 +02:00
Guido van Rossum
16ca06b8cb
Add collections.Reversible. Patch by Ivan Levkivskyi. Fixes issue #25987 .
2016-04-04 10:59:29 -07:00
Martin Panter
446977c080
Issue #25286 : Merge dictionary view glossary from 3.4 into 3.5
2015-10-07 10:01:04 +00:00
Martin Panter
85b8f45515
Issue #25286 : Dictionary views are not sequences
...
Also change glossary heading from view
2015-10-07 09:56:46 +00:00
Yury Selivanov
fdbeb2b4b6
Issue #24400 : Resurrect inspect.isawaitable()
...
collections.abc.Awaitable and collections.abc.Coroutine no longer
use __instancecheck__ hook to detect generator-based coroutines.
inspect.isawaitable() can be used to detect generator-based coroutines
and to distinguish them from regular generator objects.
2015-07-03 13:11:35 -04:00
Yury Selivanov
cc1d0287b5
Issue #24400 : Mention that __instancecheck__ is used in abc.Awaitable and Coroutine
2015-07-01 12:49:00 -04:00
Yury Selivanov
66f8828bfc
Issue #24439 : Improve PEP 492 related docs.
...
Patch by Martin Panter.
2015-06-24 11:04:15 -04:00
Senthil Kumaran
b4760efbad
Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple documentation typos.
...
Related Issues:
#issue21528
#issue24453
2015-06-14 17:35:37 -07:00
Yury Selivanov
56fc614025
Issue 24315: Make collections.abc.Coroutine derived from Awaitable
2015-05-29 09:01:29 -04:00
Raymond Hettinger
ec219ba1c0
Issue #23086 : Add start and stop arguments to the Sequence.index() mixin method.
2015-05-22 19:29:22 -07:00
Yury Selivanov
f3e40fac10
Issue 24180: Documentation for PEP 492 changes.
2015-05-21 11:50:30 -04:00
Raymond Hettinger
bd60e8dece
Issue #24018 : Add a collections.Generator abstract base class.
2015-05-09 01:07:23 -04:00
Georg Brandl
e21a531ef1
merge with 3.4
2014-10-31 10:39:29 +01:00
Georg Brandl
8ed75cd8e9
#22613 : minor other fixes in library docs (thanks Jacques Ducasse)
2014-10-31 10:25:48 +01:00
Raymond Hettinger
748ff8bfd1
merge
2014-07-03 00:31:54 +01:00
Raymond Hettinger
11cda47661
Fix guidance for subclassing collections.Set()
2014-07-03 00:31:30 +01:00