Contains metadata about a Python function, extracted from its docstring.
| 78 | |
| 79 | @dataclass |
| 80 | class FuncDocumentation: |
| 81 | """Contains metadata about a Python function, extracted from its docstring.""" |
| 82 | |
| 83 | name: str |
| 84 | """The name of the function, via `__name__`.""" |
| 85 | description: str | None |
| 86 | """The description of the function, derived from the docstring.""" |
| 87 | param_descriptions: dict[str, str] | None |
| 88 | """The parameter descriptions of the function, derived from the docstring.""" |
| 89 | |
| 90 | |
| 91 | DocstringStyle = Literal["google", "numpy", "sphinx"] |
no outgoing calls
no test coverage detected