Skip to content

Commit 7c0681f

Browse files
committed
Update Readme
Ready for integration with vscode-python DonJayamanne/pythonVSCode#165 microsoft/vscode-python#62
1 parent c4a0f15 commit 7c0681f

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

README.rst

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ pydocstring
77
:target: https://travis-ci.org/robodair/pydocstring
88

99
.. image:: https://coveralls.io/repos/github/robodair/pydocstring/badge.svg?branch=master
10-
:target: https://coveralls.io/github/robodair/pydocstring?branch=master
10+
:target: https://coveralls.io/github/robodair/pydocstring?branch=master
1111

1212

1313
.. image:: https://readthedocs.org/projects/pydocstring/badge/?version=latest
@@ -26,28 +26,38 @@ pydocstring
2626
:target: https://pypi.org/project/pydocstring/
2727

2828

29-
Python package for autogenerating python docstrings
29+
Python package for autogenerating python docstrings, built on top of `Parso <https://github.com/davidhalter/parso>`_.
3030

3131

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.
3433

3534
Status
3635
======
3736

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.
3940

4041
Doesn't support more complicated things like converting between styles or updating docstrings.
4142

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+
4252
Docs
4353
====
4454

4555
Documentation is on `Read The Docs <http://pydocstring.readthedocs.io/>`_
4656

4757
API
48-
---
58+
===
4959

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.
5161

5262
Download
5363
========
@@ -57,14 +67,3 @@ pydocstring is on `PyPI <https://pypi.org/project/pydocstring/>`_ and can be ins
5767
.. code-block:: bash
5868
5969
pip install pydocstring
60-
61-
62-
TODO
63-
====
64-
65-
Feel free to help out on one of these
66-
67-
- Conversion between docstring styles
68-
- Updating docstrings (with parameters removed, exceptions no longer thrown, etc)
69-
- Optional in-place addition of docstrings to file(s) when run on the command line
70-

pydocstring/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:py:func:`pydocstring.generate_docstring` with the source code and the position of your cursor.
44
"""
55

6-
__version__ = "0.0.dev19"
6+
__version__ = "0.1.1"
77

88
import parso
99
from parso.python.tree import search_ancestor, BaseNode

0 commit comments

Comments
 (0)