You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Python package for autogenerating python docstrings
29
+
Python package for autogenerating python docstrings, built on top of `Parso <https://github.com/davidhalter/parso>`_.
30
30
31
31
32
-
The idea is that this project can be wrapped by an editor extension to provide docstrings as autocompletion or in response to a shortcut.
33
-
32
+
This project can be wrapped by an editor extension to provide docstrings as autocompletion or in response to a shortcut command.
34
33
35
34
Status
36
35
======
37
36
38
-
Beta, ready for basic use - Supports Google, Numpy, and reST docstring formatting but no others (it's really simple to add one though)
37
+
Ready for basic use - Supports **Google**, **Numpy**, and **reST** docstring formats are supported, and it's pretty simple to create your own formatter.
38
+
39
+
Types are able to be inferred for some things, but if they can't be worked out '``TYPE``' is just inserted instead.
39
40
40
41
Doesn't support more complicated things like converting between styles or updating docstrings.
41
42
43
+
Future
44
+
======
45
+
46
+
Check the issues for any more, but the nice-to-haves are:
47
+
48
+
- Docstring insertion for a whole file
49
+
- Updating docstrings for methods with changed paramenters/exeptions/Types
50
+
- Conversion between docstring styles
51
+
42
52
Docs
43
53
====
44
54
45
55
Documentation is on `Read The Docs <http://pydocstring.readthedocs.io/>`_
46
56
47
57
API
48
-
---
58
+
===
49
59
50
-
For integration with editors, there's a really simple api avaialble (just a single call), check out the docs for more on that
60
+
For integration with editors, there's a really simple api avaialble (just a single call), check out the docs for more on that.
51
61
52
62
Download
53
63
========
@@ -57,14 +67,3 @@ pydocstring is on `PyPI <https://pypi.org/project/pydocstring/>`_ and can be ins
0 commit comments