Commit Graph

60 Commits

Author SHA1 Message Date
Ethan Furman a4b1bb4801
bpo-31801: Enum: add _ignore_ as class option (#5237)
* bpo-31801:  Enum:  add _ignore_ as class option

_ignore_ is a list, or white-space seperated str, of names that will not
be candidates for members; these names, and _ignore_ itself, are removed
from the final class.

* bpo-31801:  Enum:  add documentation for _ignore_

* bpo-31801: Enum: remove trailing whitespace

* bpo-31801: Enum: fix bulleted list format

* bpo-31801: add version added for _ignore_
2018-01-22 07:56:37 -08:00
Julian Kahnert 0f31c74fcf Improve enum.Flag code example (GH-5167)
The code example that demonstrate how to use enum.Flag was missing
the import of enum.auto.
2018-01-12 19:35:57 -08:00
Kartik Anand 626584284e correct documentation for enum.html (#358) 2017-02-28 21:07:18 +01:00
Berker Peksag 2a267a12ee Issue #29129: Fix typo in "Using auto" section 2017-01-02 05:51:04 +03:00
Ethan Furman 23bb6f48ea close issue28172: Change all example enum member names to uppercase, per Guido; patch by Chris Angelico. 2016-11-21 09:22:05 -08:00
Ethan Furman 3515dcce80 issue23591: fix flag decomposition and repr 2016-09-18 13:15:41 -07:00
Ethan Furman c16595e567 issue23591: add auto() for auto-generating Enum member values 2016-09-10 23:36:59 -07:00
Ethan Furman 54924df2b1 improve Enum docs 2016-09-07 23:40:31 -07:00
Ethan Furman 6a137e8d50 add recipes for pseudo-valueless enums 2016-09-07 08:17:15 -07:00
Ethan Furman 27682d2698 issue23591: more docs; slight change to repr 2016-09-04 11:39:01 -07:00
Ethan Furman 25d94bbf05 issue23591: bool(empty_flags) == False; more docs & tests 2016-09-02 16:32:32 -07:00
Ethan Furman 65a5a47d79 issue23591: add docs; code cleanup; more tests 2016-09-01 23:55:19 -07:00
Ethan Furman e8e61277ff issue26981: add _order_ compatibility shim to enum.Enum 2016-08-20 07:19:31 -07:00
Ethan Furman 332dbc7325 Issue26988: remove AutoEnum 2016-08-20 00:00:52 -07:00
Berker Peksag 43b586b951 Silence warnings from 'make suspicious' to make the docs buildbot happy 2016-08-06 13:37:22 +03:00
Ethan Furman 73fc586d9f Add AutoEnum: automatically provides next value if missing. Issue 26988. 2016-08-05 16:03:16 -07:00
Martin Panter 2fec611a70 Issue #24314: Merge doc links from 3.5 2016-06-18 08:20:22 +00:00
Martin Panter bae5d81f5d Issue #24314: Fix doc links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Martin Panter e514093a2f Issue #27125: Merge typo fixes from 3.5 2016-05-30 05:24:49 +00:00
Martin Panter a90a4a9651 Issue #27125: Remove duplicated words from documentation and comments 2016-05-30 04:04:50 +00:00
Martin Panter bc1ee460dc Issue #25179: Documentation for formatted string literals aka f-strings
Some of the inspiration and wording is taken from the text of PEP 498 by Eric
V. Smith, and the existing str.format() documentation.
2016-02-13 00:41:37 +00:00
Martin Panter 46988d3659 Merge string formatting doc fixes from 3.5 2016-02-08 01:49:35 +00:00
Martin Panter d5db14794b Issue #25179: Preparatory cleanup of existing docs on string formatting
* Various sections were pointing to the section on the string.Formatter
  class, when the section on the common format string syntax is probably more
  appropriate
* Fix references to various format() functions and methods
* Nested replacement fields may contain conversions and format specifiers,
  and this is tested; see Issue #19729 for instance
2016-02-08 01:34:09 +00:00
Ethan Furman 2ae4ea54a2 use public 'value' 2016-01-16 12:39:53 -08:00
Ethan Furman 60255b67b9 revert change 87a9dff5106c: pure Enum members again evaluate to True;
update Finer Points section of docs to cover boolean evaluation;
add more tests for pure and mixed boolean evaluation
2016-01-15 15:01:33 -08:00
Ethan Furman 748dad5b6a Close 25594: advise against accessing Enum members from other members 2015-11-20 13:12:26 -08:00
Ethan Furman 92e5d2f0eb Close issue25594: advise against accessing Enum members from other members 2015-11-20 13:17:27 -08:00
Victor Stinner 91108f049f Issue #25210: Change error message of do_richcompare()
Don't add parenthesis to type names. Add also quotes around the type names.

Before:

  TypeError: unorderable types: int() < NoneType()

After:

  TypeError: '<' not supported between instances of 'int' and 'NoneType'
2015-10-14 18:25:31 +02:00
Martin Panter 84835ab1cb Issue #25161: Merge full stops from 3.4 into 3.5 2015-10-10 10:44:25 +00:00
Martin Panter d21e0b52f1 Issue #25161: Add full stops in documentation; patch by Takase Arihiro 2015-10-10 10:36:22 +00:00
Yury Selivanov 4dde587405 whatsnew/3.5: Sync whatsnew with versionadded/versionchanged doc tags 2015-09-11 00:48:21 -04:00
Ethan Furman 61f50bb488 Issue22997: minor doc update; thanks to Simoen Visser 2015-01-14 22:32:29 -08:00
Ethan Furman 8a12329281 Issue22997: minor doc update; thanks to Simoen Visser 2015-01-14 22:31:50 -08:00
Ethan Furman 8be6fac103 standardize Enum docs by referring to 'special methods' instead of __dunder__ methods 2014-11-01 07:40:22 -07:00
Georg Brandl 93a56cdc37 Doc: fix default role usage (except in unittest mock docs) 2014-10-30 22:25:41 +01:00
Berker Peksag 60efd79dc5 Issue #21706: Add a versionchanged directive to the functional API docs. 2014-09-18 05:23:14 +03:00
Ethan Furman d9925a18ec Close issue21706: add 'start' parameter to functional API 2014-09-16 20:35:55 -07:00
Ethan Furman f75805edb8 Issue21738: clarify usage of __new__ in Enum subclasses 2014-09-16 19:13:31 -07:00
Zachary Ware dbd1c43e52 Fix spelling in enum docs.
"equivalant" was caught by Tobias Käs on docs@, "seperated" and "chartruese"
were discovered by a spell-checker.
2014-03-20 10:01:48 -05:00
Larry Hastings 3732ed2414 Merge in all documentation changes since branching 3.4.0rc1. 2014-03-15 21:13:56 -07:00
Ethan Furman 01cc2d5fb8 Issue20653: fix ReST for Enum 2014-03-03 15:02:04 -08:00
Ethan Furman 2da950460d Close issue20653: improve functional API docs; minor code changes 2014-03-03 12:42:52 -08:00
Larry Hastings ad88d7a26b Python 3.4.0rc1 release: Updated pydoc topics, fixed suspicious markup errors. 2014-02-10 04:26:10 -08:00
Ethan Furman ca1b794dac Close issue20534: all pickle protocols now supported. 2014-02-08 11:36:27 -08:00
Ethan Furman c72e638643 Close issue20412: Updated Enum docs to have referencable Enum and IntEnum classes 2014-02-06 08:13:14 -08:00
R David Murray fd1ff1c888 Add versionadded to enum docs. 2013-12-20 14:20:49 -05:00
Serhiy Storchaka 98b28fddd8 Issue #18758: Fixed and improved cross-references. 2013-10-13 23:12:09 +03:00
Ezio Melotti 17f1eddcfe Add missing comma. 2013-10-05 04:26:06 +03:00
Ezio Melotti 93d7dda914 #19148: fix markup errors and wording in enum docs. Patch by Esa Peuha. 2013-10-05 04:13:18 +03:00
Ethan Furman 9a1daf5765 Close #19011: Add documentation on some of the non-standard Enum behavior.
Issues such as iterating and containment on Enum classes, why Enum member
instances do not show up on other Enum members, and how __new__ should
be used.
2013-09-27 22:58:06 -07:00