summaryrefslogtreecommitdiffstats
path: root/Doc/library/collections.abc.rst
Commit message (Collapse)AuthorAgeFilesLines
* Clarify that Set._from_iterable is not required to be a classmethod. ↵Miss Islington (bot)2020-11-211-1/+1
| | | | (GH-23272) (GH-23450)
* bpo-40994: Ungroup items in collections.abc documentation for improved ↵Miss Islington (bot)2020-08-221-5/+13
| | | | | | | | | | | clarity (GH-21880) (#21926) Use a less surprising document structure. Automerge-Triggered-By: @csabella (cherry picked from commit 2ce39631f679e14132a54dc90ce764259d26e166) Co-authored-by: Sydney Pemberton <46042811+sydneypemberton1986@users.noreply.github.com>
* [3.9] bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) (GH-21901)Victor Stinner2020-08-191-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * bpo-40204: Allow pre-Sphinx 3 syntax in the doc (GH-21844) Enable Sphinx 3.2 "c_allow_pre_v3" option and disable the c_warn_on_allowed_pre_v3 option to make the documentation compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 423e77d6de497931585d1883805a9e3fa4096b0b) * bpo-40204: Fix Sphinx sytanx in howto/instrumentation.rst (GH-21858) Use generic '.. object::' to declare markers, rather than abusing '.. c:function::' which fails on Sphinx 3. (cherry picked from commit 43577c01a2ab49122db696e9eaec6cb31d11cc81) * bpo-40204: Fix duplicates in the documentation (GH-21857) Fix two Sphinx 3 issues: Doc/c-api/buffer.rst:304: WARNING: Duplicate C declaration, also defined in 'c-api/buffer'. Declaration is 'PyBUF_ND'. Doc/c-api/unicode.rst:1603: WARNING: Duplicate C declaration, also defined in 'c-api/unicode'. Declaration is 'PyObject* PyUnicode_Translate(PyObject *str, PyObject *table, const char *errors)'. (cherry picked from commit 46d10b1237c67ff8347f533eda6a5468d098f7eb) * bpo-40204: Add :noindex: in the documentation (GH-21859) Add :noindex: to duplicated documentation to fix "duplicate object description" errors. For example, fix this Sphinx 3 issue: Doc/library/configparser.rst:1146: WARNING: duplicate object description of configparser.ConfigParser.optionxform, other instance in library/configparser, use :noindex: for one of them (cherry picked from commit d3ded080482beae578faa704b13534a62d066f9f) * bpo-40204, doc: Fix syntax of C variables (GH-21846) For example, fix the following Sphinx 3 errors: Doc/c-api/buffer.rst:102: WARNING: Error in declarator or parameters Invalid C declaration: Expected identifier in nested name. [error at 5] void \*obj -----^ Doc/c-api/arg.rst:130: WARNING: Unparseable C cross-reference: 'PyObject*' Invalid C declaration: Expected end of definition. [error at 8] PyObject* --------^ The modified documentation is compatible with Sphinx 2 and Sphinx 3. (cherry picked from commit 474652fe9346382dbf793f20b671eb74668bebde) * 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. (cherry picked from commit bb0b08540cc93e56f3f1bde1b39ce086d9e35fe1) * bpo-40204: Fix duplicated productionlist names in the doc (GH-21900) Sphinx 3 disallows having more than one productionlist markup with the same name. Simply remove names in this case, since names are not shown anyway. For example, fix the Sphinx 3 warning: Doc/reference/introduction.rst:96: duplicate token description of *:name, other instance in reference/expressions (cherry picked from commit 1abeda80f760134b4233608e2c288790f955b95a)
* bpo-32467: Let collections.abc.ValuesView inherit from Collection (#5152)Raymond Hettinger2018-01-121-1/+2
|
* bpo-18558: Clarify glossary entry for "Iterable" (#3732)Raymond Hettinger2017-09-251-1/+6
|
* Issue #28793: Fix c/p error in AsyncGenerator documentationBerker Peksag2016-11-251-1/+1
| | | | Patch by Julien Palard.
* Issue #28720: Add collections.abc.AsyncGenerator.Yury Selivanov2016-11-161-0/+8
|
* Issue 27598: Add Collections to collections.abc.Guido van Rossum2016-08-231-9/+17
| | | | Patch by Ivan Levkivskyi, docs by Neil Girdhar.
* Anti-registration of various ABC methods.Guido van Rossum2016-08-181-1/+2
| | | | | | | | | | - 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.
* Merge for #26696Brett Cannon2016-07-151-1/+4
|\
| * Issue #26696: Document collections.abc.ByteString.Brett Cannon2016-07-151-1/+4
| | | | | | | | Thanks to Xiang Zhang for the patch.
* | Merge Issue #22558.Terry Jan Reedy2016-06-111-2/+3
|\ \ | |/
| * Issue #22558: Add remaining doc links to source code for Python-coded modules.Terry Jan Reedy2016-06-111-2/+3
| | | | | | | | | | Reformat header above separator line (added if missing) to a common format. Patch by Yoni Lavi.
* | Issue #23921: Standardized documentation whitespace formatting.Serhiy Storchaka2016-05-101-13/+16
|\ \ | |/ | | | | Original patch by James Edwards.
| * Issue #23921: Standardized documentation whitespace formatting.Serhiy Storchaka2016-05-101-13/+16
| | | | | | | | Original patch by James Edwards.
* | Issue #26736: Used HTTPS for external links in the documentation if possible.Serhiy Storchaka2016-05-071-1/+1
|\ \ | |/
| * Issue #26736: Used HTTPS for external links in the documentation if possible.Serhiy Storchaka2016-05-071-1/+1
| |
* | #25987: add versionadded to Reversible.Georg Brandl2016-04-181-0/+2
| |
* | Add collections.Reversible. Patch by Ivan Levkivskyi. Fixes issue #25987.Guido van Rossum2016-04-041-1/+6
|/
* Issue #25286: Merge dictionary view glossary from 3.4 into 3.5Martin Panter2015-10-071-1/+1
|\
| * Issue #25286: Dictionary views are not sequencesMartin Panter2015-10-071-1/+1
| | | | | | | | Also change glossary heading from view
| * Back porting changeset db302b88fdb6 to 3.4 branch, which fixed multiple ↵Senthil Kumaran2015-06-151-1/+1
| | | | | | | | | | | | | | | | | | documentation typos. Related Issues: #issue21528 #issue24453
* | Issue #24400: Resurrect inspect.isawaitable()Yury Selivanov2015-07-031-8/+10
| | | | | | | | | | | | | | | | 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.
* | Issue #24400: Mention that __instancecheck__ is used in abc.Awaitable and ↵Yury Selivanov2015-07-011-0/+12
| | | | | | | | Coroutine
* | Issue #24439: Improve PEP 492 related docs.Yury Selivanov2015-06-241-9/+10
| | | | | | | | Patch by Martin Panter.
* | Issue 24315: Make collections.abc.Coroutine derived from AwaitableYury Selivanov2015-05-291-5/+5
| |
* | Issue #23086: Add start and stop arguments to the Sequence.index() mixin method.Raymond Hettinger2015-05-231-0/+14
| |
* | Issue 24180: Documentation for PEP 492 changes.Yury Selivanov2015-05-211-3/+42
| |
* | Issue #24018: Add a collections.Generator abstract base class.Raymond Hettinger2015-05-091-0/+10
| |
* | merge with 3.4Georg Brandl2014-10-311-1/+1
|\ \ | |/
| * #22613: minor other fixes in library docs (thanks Jacques Ducasse)Georg Brandl2014-10-311-1/+1
| |
* | mergeRaymond Hettinger2014-07-021-1/+1
|\ \ | |/
| * Fix guidance for subclassing collections.Set()Raymond Hettinger2014-07-021-1/+1
| |
* | Fix Issue #21528 - Fix documentation typosDonald Stufft2014-05-201-1/+1
|/
* Issue #18758: Fixed and improved cross-references.Serhiy Storchaka2013-10-131-2/+3
|\
| * Issue #18758: Fixed and improved cross-references.Serhiy Storchaka2013-10-131-2/+3
| |
* | Issue #19218: Rename collections.abc to _collections_abc in order to speed ↵Christian Heimes2013-10-131-1/+1
|/ | | | up interpreter start
* Update code examples using collections.abc classes.Georg Brandl2013-04-141-2/+2
|
* Closes #4159: add LaTeX tabular column specifications to tables that ↵Georg Brandl2013-03-281-1/+3
| | | | otherwise are cut off or have overlapping text.
* Update collections ABC table to match the __abstractmethods__ attribute for ↵Raymond Hettinger2013-03-231-21/+27
| | | | each container.
* Issue #16711: Fix required method names for collections.IteratorAndrew Svetlov2012-12-181-1/+1
| | | | Thanks to Inada Naoki
* Move versionadded directive to the top level, as we do in other filesÉric Araujo2011-08-161-2/+3
|
* Merge ABC and distutils touch-ups from 3.2.Éric Araujo2011-06-041-4/+4
| | | | | | | | 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.
* Fix reST label for collections ABCs.Éric Araujo2011-06-031-1/+1
| | | | | | 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.
* #10617: merge with 3.2.Ezio Melotti2011-03-281-8/+50
|
* MergeAntoine Pitrou2011-03-221-1/+1
|
* Mentioned new clear() method of MutableSequence in its doc, and added unit ↵Eli Bendersky2011-03-041-1/+1
| | | | tests for its mixin methods
* Issue #11085: Moved collections abstract base classes into a separate moduleRaymond Hettinger2011-02-221-0/+139
called collections.abc, following the pattern used by importlib.abc. For backwards compatibility, the names continue to also be imported into the collections module.