Skip to main content

render_definition_items()

Render a section’s definitions with their names, annotations, defaults and descriptions

Usage

Source

render_definition_items(el)

Parameters, attributes and type parameters share the same declaration markup. Consecutive unnamed return, yield or receive items with the same annotation merge into one definition. The merge works on copies, so rendering again leaves the prepared items unchanged.

Parameters

el: DocstringSectionWithDefinitions
The prepared section.

Returns

BlockContent
The definitions as a definition list, or None when the section has no items.