Inline Markup :const: shows up in Documentation

[wplappert]

BPO	4167
Nosy	@birkenfeld

^{Note: these values reflect the state of the issue at the time it was migrated and might not reflect the current state.}

Show more details

GitHub fields:

assignee = 'https://github.com/birkenfeld'
closed_at = <Date 2008-11-04.20:49:43.603>
created_at = <Date 2008-10-22.06:39:14.388>
labels = ['type-bug', 'docs']
title = 'Inline Markup :const: shows up in Documentation'
updated_at = <Date 2008-11-04.20:49:43.602>
user = 'https://bugs.python.org/wplappert'

bugs.python.org fields:

activity = <Date 2008-11-04.20:49:43.602>
actor = 'georg.brandl'
assignee = 'georg.brandl'
closed = True
closed_date = <Date 2008-11-04.20:49:43.603>
closer = 'georg.brandl'
components = ['Documentation tools (Sphinx)']
creation = <Date 2008-10-22.06:39:14.388>
creator = 'wplappert'
dependencies = []
files = []
hgrepos = []
issue_num = 4167
keywords = []
message_count = 2.0
messages = ['75063', '75506']
nosy_count = 2.0
nosy_names = ['georg.brandl', 'wplappert']
pr_nums = []
priority = 'normal'
resolution = 'fixed'
stage = None
status = 'closed'
superseder = None
type = 'behavior'
url = 'https://bugs.python.org/issue4167'
versions = ['Python 2.6']

[wplappert]

The Inline Markup :const: shows up in the final documentation. Example
can be found on http://docs.python.org/library/select.html :

kevent.fflags¶

Filter specific flags

:const:`KQ_FILTER_READ` and :const:`KQ_FILTER_WRITE` filter flags
Constant 	Meaning
KQ_NOTE_LOWAT 	low water mark of a socket buffer

:const:`KQ_FILTER_VNODE` filter flags

It also shows up in the equivalent PDF documentation. The underlying rst
file is library/select.rst, relevant part of source text follows:
*:const:`KQ_FILTER_READ` and :const:`KQ_FILTER_WRITE` filter flags*

+----------------------------+--------------------------------------------+
| Constant | Meaning
|

+============================+============================================+
| :const:`KQ_NOTE_LOWAT` | low water mark of a socket buffer
|

+----------------------------+--------------------------------------------+

*:const:`KQ_FILTER_VNODE` filter flags*

There is one more occurrance of :const: in
http://docs.python.org/library/cookielib.html:
...
Cookie.is_expired([now=:const:`None`])¶
True if cookie ...

[birkenfeld]

Thanks, fixed in r67101.