docstring_parser
docstring_parser copied to clipboard
rr-
Parse Python docstrings in various flavors.
The approved [PEP 257](https://peps.python.org/pep-0257/#what-is-a-docstring) mentions the so called "attribute docstrings", which are string literals in the line after where an attribute is defined. These kind of docstrings are supported by...
At the moment, the `NumpydocParser` only looks at the description of a parameter to find its default value ([relevant code](https://github.com/rr-/docstring_parser/blob/dc43c201ef5bff40b9b4a1262b315f1815067bce/docstring_parser/numpydoc.py#L146)). However, the `numpydoc` style guide also allows specifying the default...
Parsing the following doesn't work (`long_description` fails). ```python def mock_function(boo): """ :::note Admonition with a [link](https://google.com). ::: Parameters ---------- boo: int baa """ pass ``` Interestingly, removal of any of...
- [X] fixes #51 The tests pass, but I have no idea if I did it the right way. Hoping this is easy enough for someone more experienced to pick...
Time ago, I found problems in the building process using `mkdocstrings` (here's the issue https://github.com/mkdocstrings/mkdocstrings/issues/366) as `docstring_parser` doesn't support numpydoc's Methods section. So, I'm wondering if you are open to...
# The Problem When a parameter contains new lines between the first line and the rest, those new lines are collapsed into a single new line. ```python def asdf(): '''asdf...
Maybe this is unsupportable, but I figured it was worth asking. In my library, metadata for function arguments is stored in the docstring, looking something like this: ```python def a(x=5):...
The following code snippet causes everything after `Example:` to be parsed as `long_description`. As a consequence, `params` and `raises` are lost. ``` from docstring_parser import parse if __name__ == '__main__':...
TensorFlow is a popular open-source ML framework/ecosystem from Google. Unfortunately your parser doesn't work well on its docstring. Here's a link to the docstring: https://github.com/tensorflow/tensorflow/blob/9df9d06/tensorflow/python/keras/optimizer_v2/adam.py#L35-L103 Snippet: ``` r"""Optimizer that implements...
My example, which I found [Here](https://realpython.com/documenting-python-code/): ``` """Gets and prints the spreadsheet's header columns :param file_loc: The file location of the spreadsheet :type file_loc: str :param print_cols: A flag used...
