autoDocstring

autoDocstring copied to clipboard

The only change needed would be to add an exclaimation point to the end of the leading triple-quote. Otherwise the templating system works well. I'm pasting the template I created...

mgannprc

I have a custom template I'd like to use in all my python projects across several different computers, but the `"autoDocstring.customTemplatePath"` setting only accepts a path relative to the project...

thehale

There is a way to configure more than one custom template? The goal is to set different types of docstring for classes of functions, for instance.

felipeor93

using the "Format Document (With)" features of VS code; incl. the possibility to change the docstring style

cryptopist

## What Setting to insert the docstring as raw text, by prepending the opening triple-quotes with 'r'. ## Why When visualizing Math with LaTex in docstring meant for Sphinx and...

ldanov

Arbitrary argument lists (*args) being ignored by docstring generator

4

**Describe the bug** Arbitrary argument lists (`*args`) are not included in the list of arguments generated by autoDocstring. **Versions (please complete the following information):** - autoDocstring Version: v0.5.4 - Operating...

osharaki

Docstring will not generate when triple quote string exists in function body

3

This only happens when the quote style is the same as the triple quote string inside the function body. Also happens with non-*f-strings*. See example:  ```python...

misharigot

Optionally write types in docstring - PEP 484

12

Functions implementing [PEP 484](https://www.python.org/dev/peps/pep-0484/) annotate arguments' type in their signature. It feels a bit redundant to mention args type again in docstrings. According to at least [Sphinx Napoleon's doc](https://sphinxcontrib-napoleon.readthedocs.io/en/latest/example_google.html) the...

slmg

[Bug] Does not recognise function parameters when split over multiple lines with the `\` character.

1

**Describe the bug** When generating these docstrings, it works fine when all the params of the function are listed in the same line. However, when the function definition line is...

chrimaho

Does not generate docstring with @dataclass decorator

8

**Describe the bug** It does not generate correct docstring when defining a class using @dataclass decorator method. It works fine with traditional class initialization. I have even tried with all...

Akashdesarda