Commit graph

50 commits

Author SHA1 Message Date
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
Donald Stufft
8b852f111e Fix Issue #21528 - Fix documentation typos 2014-05-20 12:58:38 -04:00
Serhiy Storchaka
98b28fddd8 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:12:09 +03:00
Serhiy Storchaka
bfdcd436f0 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:09:14 +03:00
Christian Heimes
f1dc3ee16d Issue #19218: Rename collections.abc to _collections_abc in order to speed up interpreter start 2013-10-13 02:04:20 +02:00
Georg Brandl
5f4b4ac73e Update code examples using collections.abc classes. 2013-04-14 10:50:05 +02:00
Georg Brandl
44ea77bd81 Closes #4159: add LaTeX tabular column specifications to tables that otherwise are cut off or have overlapping text. 2013-03-28 13:28:44 +01:00
Raymond Hettinger
3ddba16aa6 Update collections ABC table to match the __abstractmethods__ attribute for each container. 2013-03-23 09:07:36 -07:00
Andrew Svetlov
e2303f8970 Issue #16711: Fix required method names for collections.Iterator
Thanks to Inada Naoki
2012-12-18 15:53:15 +02:00
Éric Araujo
b389eec440 Move versionadded directive to the top level, as we do in other files 2011-08-16 19:10:24 +02:00
Éric Araujo
459b452b98 Merge ABC and distutils touch-ups from 3.2.
I have removed the reST target I added in 38cdca2cc253: it is not necessary, as
people can link to the glossary entry or the abc module without it.

Two indentation fixes from 3.2 collections.rst have been ported to 3.3
collections.abc.rst.
2011-06-04 21:16:42 +02:00
Éric Araujo
f90112efe8 Fix reST label for collections ABCs.
The previous markup hijacked the abstract-base-classes glossary entry,
which resulted in the HTML linking to collections.abc when defining the
generic ABC concept.  Now the glossary links to the abc module.
2011-06-03 19:18:41 +02:00
Ezio Melotti
c831a91931 #10617: merge with 3.2. 2011-03-28 19:27:09 +03:00
Antoine Pitrou
36920354c7 Merge 2011-03-22 18:33:33 +01:00
Eli Bendersky
0716a579a4 Mentioned new clear() method of MutableSequence in its doc, and added unit tests for its mixin methods 2011-03-04 10:38:14 +00:00
Raymond Hettinger
158c9c26fc Issue #11085: Moved collections abstract base classes into a separate module
called collections.abc, following the pattern used by importlib.abc.  For
backwards compatibility, the names continue to also be imported into the
collections module.
2011-02-22 00:41:50 +00:00