Skip to main content

docstring_subject()

The first paragraph of the docstring, on one line, shown as the subject

Usage

Source

docstring_subject()

The paragraph may wrap over several lines; it ends at the first blank line. There is no subject when the docstring does not start with a text section, or when it opens with a code fence, display maths ($$) or a fenced div (:::). Body callbacks do not receive the subject.