Skip to content

PEP 257 Docstring Processor

Docstring processor for PEP 257 and Google docstring format.

Supported features

  • <known_section>: starts a new section <known_section>
  • <name>: <description> formatted in Markdown style and added to named sections
  • <name> (<?type>): <description> formatted in Markdown style and added to named sections
  • <name> (<?type>,optonal): <description> formatted in Markdown style and added to named sections
  • <name> -- <description> formatted in Markdown style and added to named sections
  • <name> {<type>} -- <description> formatted in Markdown style and added to named sections
  • <name> {[<type>]} -- <description> formatted in Markdown style and added to named sections
  • <name> <?type>, optonal: <description> formatted in Markdown style and added to named sections
  • <name> -- <description> formatted in Markdown style

Handsdown API Index / Handsdown / Processors / PEP 257 Docstring Processor

Auto-generated documentation for handsdown.processors.pep257 module.

PEP257DocstringProcessor

Show source in pep257.py:33

Docstring processor for PEP 257 and Google docstring format.

Signature

class PEP257DocstringProcessor(BaseDocstringProcessor):
    ...

See also