Skip to content

Fix typo, add vim-plug installation instructions #88

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 26, 2020
Merged

Fix typo, add vim-plug installation instructions #88

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ You can install following command.

$ make install


This can be automated with vim-plug.

.. code::

Plug 'heavenshell/vim-pydocstring', { 'do': 'make install' }


If you want install doq manually, you can install from PyPi.

.. code::
Expand All @@ -33,7 +41,6 @@ If you want install doq manually, you can install from PyPi.

Than set installed `doq <https://pypi.org/project/doq/>`_ path to `g:pydocstring_doq_path`.


Note
~~~~

Expand Down Expand Up @@ -79,7 +86,7 @@ You can set built-in formatter(Sphinx, Numpy, Google).

.. code::

leg g:pydocstring_formatter = 'numpy'
let g:pydocstring_formatter = 'numpy'


Custom template
Expand Down