autoDocstring

autoDocstring copied to clipboard

**Describe the bug** I use the extension autoDocstring quite extensively in generating templates when documenting the functions and classes. When doing so, I have noticed that it doesn't handle unicode...

nikhil003

resolves #181 Add AssertionError

1

This PR resolves #181. It adds a second loop to the `parseExceptions()` function, which searches for a different pattern (`/(?

chrimaho

**Describe the bug** The current template for google docstring's `Returns` section is as follows: ``` Returns: _type_: _description_ ``` The [Google Python Style Guide](https://google.github.io/styleguide/pyguide.html#doc-function-returns) suggests a sentence like `A dict...

ubalklen

**Describe the bug** Python has a `NoReturn` type ([docs](https://docs.python.org/3/library/typing.html#typing.NoReturn)) used to indicate that a function can never return (it's used by static analysis tools to analyse dead code zones). Currently...

jpy-git

Incorrect usage of "optional" in argument type

4

When writing the following function ``` def my_function(arg: int = 3) -> int: return arg ``` autoDocstring generates the following docstring automatically (using Google style docstrings): ``` def my_function(arg: int...

willemvdb42

Add template google-notypes-nodefault

1

This is the same template as google-notypes just without having "Defaults to x" for kwargs. The reason for adding this is that the default value for the kwargs is already...

sv1990

Match CRLF when condensing template new lines

1

This change fixes #198, where templates saved with CRLF line returns will generate unwanted trailing white spaces and new lines.

justinchuby

Remove inline comments during line preprocessing

5

Looks like the current implementation only removes lines that start with "#" to filter comments. As described in issue #160, inline comments are missed. This should resolve issue #160.

IniasP

Add "Module docstring"

1

**Describe the feature request** Is there a way to use this extension also to generate the module doc string? I know very popular one like google or numpy are already...

federicovallucci

Fold/Unfold Docstring paragraph

1

labels: feature request Can be added fold/unfold docstring paragraph? It's will help us with a fast overview code. Thank you.

supakwong