Translator of docstrings to Markdown format.
Handsdown API Index / Handsdown / Utils / DocstringFormatter
Auto-generated documentation for handsdown.utils.docstring_formatter module.
Show source in docstring_formatter.py:7
Translator of docstrings to Markdown format.
docstring- Raw docstring.
class DocstringFormatter:
def __init__(self, docstring: str) -> None: ...Show source in docstring_formatter.py:23
Fix multiline docstrings starting with no newline after quotes.
docstring- Raw docstring.
Aligned docstring.
@staticmethod
def _cleanup(docstring: str) -> str: ...Show source in docstring_formatter.py:57
Get Markdown-friendly docstring.
A cleaned up docstring.
def render(self) -> str: ...