Skip to content

Commit

Permalink
Fix readme (#93)
Browse files Browse the repository at this point in the history
  • Loading branch information
heavenshell authored Apr 28, 2020
1 parent d398a40 commit af5f9dd
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
pydocstring.vim
vim-pydocstring
===============

.. image:: https://travis-ci.org/heavenshell/vim-pydocstring.svg?branch=master
:target: https://travis-ci.org/heavenshell/vim-pydocstring

.. image:: ./assets/vim-pydocstring.gif

Pydocstring is a generator for Python docstrings and is capable of automatically
vim-pydocstring is a generator for Python docstrings and is capable of automatically

* inserting one-line docstrings
* inserting multi-line docstrings
Expand All @@ -16,7 +16,7 @@ This plugin is heavily inspired by `phpdoc.vim <http://www.vim.org/scripts/scrip
Install
-------

Since version 2, pydocstring requires `doq <https://pypi.org/project/doq/>`_.
Since version 2, vim-pydocstring requires `doq <https://pypi.org/project/doq/>`_.

You can install following command.

Expand Down Expand Up @@ -44,7 +44,10 @@ Than set installed `doq <https://pypi.org/project/doq/>`_ path to `g:pydocstring
Note
~~~~

pydocstring is now support only Vim8.
vim-pydocstring support Vim8.

Neovim works since v2.2.0, but if something wrong, send me pull requests to fix it.

If you want use old version checkout `1.0.0 <https://github.com/heavenshell/vim-pydocstring/releases/tag/1.0.0>`_

Basic usage
Expand Down

0 comments on commit af5f9dd

Please sign in to comment.