Skip to content

DocstringFormatter

Handsdown API Index / Handsdown / Utils / DocstringFormatter

Auto-generated documentation for handsdown.utils.docstring_formatter module.

DocstringFormatter

Show source in docstring_formatter.py:9

Translator of docstrings to Markdown format.

Arguments

  • docstring - Raw docstring.

Signature

class DocstringFormatter:
    def __init__(self, docstring: str) -> None:
        ...

DocstringFormatter._cleanup

Show source in docstring_formatter.py:24

Fix multiline docstrings starting with no newline after quotes.

Arguments

  • docstring - Raw docstring.

Returns

Aligned docstring.

Signature

@staticmethod
def _cleanup(docstring: str) -> str:
    ...

DocstringFormatter().render

Show source in docstring_formatter.py:57

Get Markdown-friendly docstring.

Returns

A cleaned up docstring.

Signature

def render(self) -> str:
    ...