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.

Author kumar303
Recipients georg.brandl, kumar303
Date 2008-07-14.19:30:37
SpamBayes Score 0.0022978422
Marked as misclassified No
Message-id <1216063902.37.0.436580561453.issue3355@psf.upfronthosting.co.za>
In-reply-to
Content
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.
History
Date User Action Args
2008-07-14 19:31:43kumar303setspambayes_score: 0.00229784 -> 0.0022978422
recipients: + kumar303, georg.brandl
2008-07-14 19:31:42kumar303setspambayes_score: 0.00229784 -> 0.00229784
messageid: <1216063902.37.0.436580561453.issue3355@psf.upfronthosting.co.za>
2008-07-14 19:30:41kumar303linkissue3355 messages
2008-07-14 19:30:40kumar303create