CODEWITHSUNDEEP
pythoncoding-stylepython-sphinxrestructuredtextdocstring
Jocelyn delalande
Jocelyn delalande

Reputation: 5394

Multi-line description of a parameter description in python docstring

So, reStructuredText is the recommended way for Python code documentation, if you try hard enough, you can find in the sphinx documentation how to normalize your function signature documentation. All given examples are single-line, but what if a parameter description is multi-line like the following ?

def f(a, b):
    """ Does something with a and b

    :param a: something simple
    :param b: well, it's not something simple, so it may require more than eighty
              chars
    """

What is the syntax/convention for that ? Should I indent or not ? will it break reSTructuredText rendering ?

Upvotes: 84

Views: 40842

Answers (5)

user4184837
user4184837

Reputation:

Signatures rendering is based upon docutils field lists. The link contains examples of how to indent, for example if you want your item description to be an itemized or enumerated list.

See here:

:Date: 2001-08-16
:Version: 1
:Authors: - Me
          - Myself
          - I
:Indentation: Since the field marker may be quite long, the second
   and subsequent lines of the field body do not have to line up
   with the first line, but they must be indented relative to the
   field name marker, and they must line up with each other.
:Parameter i: integer

Upvotes: 4

RayLuo
RayLuo

Reputation: 19230

Good research effort from the Original Poster. It is a surprise that the canonical sphinx documentation does not give a multi-line example on params, despite the fact that multi-line document is inevitable due to the 79-character guideline in PEP8.

In practice, considering that your parameter name itself is typically a word or even longer snake_case_words, prefixed by the already lenghty <4 or 8+ spaces> :param, it would be wise to make the next line indent for just one level (i.e. 4 spaces), which matches the "hanging indents" style metioned in PEP 8.

class Foo(object):
    def f(a, bionic_beaver, cosmic_cuttlefish):
        """ Does something.

        :param a: something simple
        :param bionic_beaver: well, it's not something simple, 
            so it may require more than eighty chars,
            and more, and more
        :param cosmic_cuttlefish:
            Or you can just put all your multi-line sentences
            to start with SAME indentation.
        """

PS: You can see it in action in, for example, here. Sphinx can pick up those docstrings and generates docs without any issue.

Upvotes: 70

Lenka42
Lenka42

Reputation: 729

Yes, seems like any comfortable for you indentation works for Sphinx and pep8 doesn't argue. Also, if you don't want description to be multiline in produced documentation you may use Python traditional line breakes with \:

 def f(a, b):
    """ Does something with a and b

    :param a: something simple
    :param b: well, it's not something simple, so it may require more \
              than eighty chars
    """

Upvotes: 9

Julia Niewiejska
Julia Niewiejska

Reputation: 591

Seems that if you indent by at least one level relative to the :param: directive, it will not break reSTructuredText rendering. Personally, I prefer to align all additional lines to the first description line of that parameter. Note, that reST will also ignore new lines and render your text without your line breaks.

Unfortunately, I could not find any source that would mention this issue or give an example of a multi-line :param: description.

Upvotes: 38

Amazingred
Amazingred

Reputation: 1007

simply newline where you want the line to break.

def f(a, b):
    """ Does something with a and b

    :param a: something simple
    :param b: well, it's not something simple, 
              so it may require more than eighty
              chars
    """

Upvotes: 11

Related Questions