Skip to main content

render_docstring_section()

Render one docstring section with the method for its kind

Usage

Source

render_docstring_section(el)

Parameters

el: AnyDocstringSection
The prepared section to render.

Returns

BlockContent
The section content, or None to omit it. A section kind without a method is omitted with a warning.

Notes

Override the method for one section kind to change only that kind. Dispatch matches the section’s exact class, so a subclass of a supported section type has no method.