[New-bugs-announce] [issue3355] Display bug in :show-inheritance: for class with standard docstring

[Kumar McMillan]

New submission from Kumar McMillan <kumar.mcmillan at gmail.com>:

Using Sphinx 0.4.1 I noticed a slight display bug in rendering
:show-inheritance: for a class with a PEP 8 / PEP 257 style docstring.

i.e. multi-line docstrings are recommended by the PEPs to look like:

class Foo(SomeFoo):
    """Return a foobang

    Optional plotz says to frobnicate the bizbaz first.
    """

Using Sphinx autodoc extension, the default skin, and...

.. autoclass:: path.to.Foo
   :show-inheritance:

...will show a link to bases but immediately after it (no line break) is
the first line of the doc.  This is confusing to read.  However,
changing the docstring of the class to add a break like:

class Foo(SomeFoo):
    """
    Return a foobang

    Optional plotz says to frobnicate the bizbaz first.
    """

fixes the problem.

----------
assignee: georg.brandl
components: Documentation tools (Sphinx)
messages: 69660
nosy: georg.brandl, kumar303
severity: normal
status: open
title: Display bug in :show-inheritance: for class with standard docstring
type: behavior
versions: Python 2.5

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