[New-bugs-announce] [issue4167] Inline Markup :const: shows up in Documentation

Winfried Plappert report at bugs.python.org
Wed Oct 22 08:39:15 CEST 2008


New submission from Winfried Plappert <Winfried.Plappert at gmx.de>:

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 ...

----------
assignee: georg.brandl
components: Documentation tools (Sphinx)
messages: 75063
nosy: georg.brandl, wplappert
severity: normal
status: open
title: Inline Markup :const: shows up in Documentation
type: behavior
versions: Python 2.6

_______________________________________
Python tracker <report at bugs.python.org>
<http://bugs.python.org/issue4167>
_______________________________________


More information about the New-bugs-announce mailing list