autoDocstring icon indicating copy to clipboard operation
autoDocstring copied to clipboard

VSCode extension that generates docstrings for python files

Results 102 autoDocstring issues
Sort by recently updated
recently updated
newest added

**Describe the bug** Not working properly for class documentation, should add __init__ args & *kwargs to class docstring instead of treating base class as arguments **Versions (please complete the following...

bug

**Describe the bug** Right now we have to put cursor below the function definition and then press enter and then generate the docstring. The best way is that wherever on...

bug

Document assertions used by a method in functions to allow for optimization with some amount of safety by adding an `asserts` section to the docstring.

**Describe the bug** Adding `Literal["something", "otherthing"] will lead to a very weird output by autoDocstring: **Versions (please complete the following information):** - autoDocstring Version: 0.6.1 - Operating System: Linux Fedora...

bug

**Describe the bug** When you set a conditional value for the function argument, the default value shown in the doc is weirdly formatted! **Versions (please complete the following information):** -...

bug

I would like to be able to configure the class documentation template. How should I do that? ![微信截图_20240528155047](https://github.com/NilsJPWerner/autoDocstring/assets/112378987/0f346533-88b0-48ed-8f78-dd49bcd78d48) I also hope it can support file header comments.

This change strips out comments before tokenizing the parameter string closes #252

If a function uses the words `class` or `def` in it's signature, it breaks the definition identification. This expands the match to include the function/class name and arguments to disambiguate...

I've tried editing the template in a number of different ways, but cannot for the life of me find a way to add an extra newline at the end of...

bug

**Describe the bug** The docstring indicates that a function yields or returns whenever there is a variable/command in the function that ends with the word "yield" or "return", even if...

bug