Commit graph

36 commits

Author SHA1 Message Date
Martin Panter
bae5d81f5d Issue #24314: Fix doc links for general attributes like __name__, __dict__ 2016-06-18 03:57:31 +00:00
Martin Panter
a90a4a9651 Issue #27125: Remove duplicated words from documentation and comments 2016-05-30 04:04:50 +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
92e5d2f0eb Close issue25594: advise against accessing Enum members from other members 2015-11-20 13:17:27 -08: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
Ethan Furman
101e0746d3 Close #18989: enum members will no longer overwrite other attributes, nor be overwritten by them. 2013-09-15 12:34:36 -07:00
Ethan Furman
455bfdea2f Close #18980: Enum doc fixes. Patch from Elazar Gershuni. 2013-09-08 23:48:34 -07:00
Ethan Furman
ed0bf8a729 Close #18908: Keep Enum docs in their own section. Patch by Elazar Gershuni. 2013-09-06 19:53:30 -07:00
Ethan Furman
ec15a826ce Close #18738: Route __format__ calls to mixed-in type for mixed Enums (such as IntEnum). 2013-08-31 19:17:41 -07:00
Ethan Furman
9026262507 fixed examples to work with changed attribute names 2013-07-30 12:24:25 -07:00
Ethan Furman
f24bb35a69 closes issue18042 -- a unique decorator is added to enum.py
The docs also clarify the 'Interesting Example' duplicate-free enum is for
demonstration purposes.
2013-07-18 17:05:39 -07:00
Ethan Furman
e2563462fc Added rationale for defaulting to 1 in the functional API. 2013-06-28 19:37:17 -07:00
Ethan Furman
3fe70b4acc Added example to enum docs show access to name and value attributes of enum members. 2013-06-28 14:02:34 -07:00
Brett Cannon
15e489f7c5 Fix markup of the synopsis along with changing to state what is in the
module and not as a definition of what an enumeration is.
2013-06-14 21:59:16 -04:00
Ethan Furman
6b3d64ab5d Closes issue 17947. Adds PEP-0435 (Adding an Enum type to the Python standard library).
Missing files added.
News entry added.
2013-06-14 16:55:46 -07:00