This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Need reST markup for enum types
Type: Stage:
Components: Documentation Versions: Python 3.7
process
Status: open Resolution:
Dependencies: Superseder:
Assigned To: docs@python Nosy List: barry, berker.peksag, docs@python, fdrake
Priority: normal Keywords:

Created on 2017-02-19 17:08 by barry, last changed 2022-04-11 14:58 by admin.

Messages (3)
msg288147 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2017-02-19 17:08
Over in https://github.com/python/cpython/pull/138 I noticed that we don't currently have markup for enum types.  While class:: is technically still correct, it's not helpful because the html documentation should render this as `Enum SafeUUID` not `class SafeUUID`.
msg288167 - (view) Author: Fred Drake (fdrake) (Python committer) Date: 2017-02-20 00:03
Is there some special treatment you think should be given to specific enum values as well?
msg288168 - (view) Author: Barry A. Warsaw (barry) * (Python committer) Date: 2017-02-20 00:13
On Feb 20, 2017, at 12:03 AM, Fred L. Drake, Jr. wrote:

>Is there some special treatment you think should be given to specific enum
>values as well?

The only thing I thought about was optionally provide the enum item's value,
when that's useful.  Usually you shouldn't care what the item's value is, but
maybe sometimes you do, and in that case it would be nice if there was a way
to express that.
History
Date User Action Args
2022-04-11 14:58:43adminsetgithub: 73787
2017-02-20 00:13:44barrysetmessages: + msg288168
2017-02-20 00:03:23fdrakesetnosy: + fdrake
messages: + msg288167
2017-02-19 17:08:14barrycreate