SublimeAutoDocstring

SublimeAutoDocstring copied to clipboard

Missing 'Returns:' section for multiline function definition

1

When generating function docstring note that `Returns:` section appears only for oneline definitions. It also updates to `No Longer Returned:` when typed manually and `Convert...` command triggered. ```(python) def foo(arg):...

czertyaka

sphinx style

2

Formatting for sphinx sections is a little more subtle than the current implementation from PR #27 would indicate. I ran some Google-styled docstrings through Napoleon (the engine that sphinx uses...

KristoforMaynard

Hello, everybody. Given the following class... ```python class ClassName(): """Summary Attributes ---------- attr1 : TYPE Description attr3 : TYPE Description """ attr1 = None attr2: str = None def __init__(self):...

Odyseus

# python script ```python def demo( complacent: bool = True, comma: str = "yes", placement=None, **kwargs, ): print("SublimeAutoDocstring save my day!") ``` # console traceback ``` Traceback (most recent call...

yellowsoar

limit line length of docs

1

Does this package include functionality to limit max char length of docs to 72/line, a la pep 257?

bitworm

Modifying default for argument does not update the type in the docstring

2

For example, write this in a new document: def function(arg=None): pass Then run any of the commands that updates the docstring, to get this: def function(arg=None): """Summary Args: arg (None,...

Lightborne

Google Style class vs instance attributes

1

Hi, this very well may just be my inexperience with docstrings, but when creating class with both static (class) and instance variables they all get lumped together under attributes. Should...

jaune-rouge

Python 3.6 adds variable annotations in [PEP 526](https://www.python.org/dev/peps/pep-0526/) to complement the type hints introduced in [PEP 484](https://www.python.org/dev/peps/pep-0484/). It would be cool for AutoDocstring to support these annotations for class attributes...

KristoforMaynard

Numpy style adds whitespace on blank lines / PEP8 W293

8

``` """Description Attributes ---------- ``` The blank line between Description and Attributes has whitespace up to the indent, and this triggers a PEP8 warning on Anaconda. Is there a way...

vassilmladenov