Skip to content

Commit cea2993

Browse files
committed
neovim
1 parent 37914ac commit cea2993

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

README.md

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
# vim-python-docstring
22
This is a plugin to Vim for creating of docstrings.
33

4+
Works also with neovim.
5+
46
## What it does
57
Docstrings for methods will contain a **list of arguments**, **list of raised exceptions** and whether the method **yields** or **raises**.
68

@@ -24,6 +26,8 @@ If you use for example Vundle, add `Plugin 'pixelneo/vim-python-docstring'` to y
2426

2527
Alternatively if you have Vim 8 and newer, you can clone this repository into `~/.vim/pack/<whatever>/start/` where `<whatever>` is *whatever* you want it to be.
2628

29+
If you have **neovim**, install python provider first: `pip3 install pynvim`.
30+
2731
## Usage
2832
The plugin has only commands which you can map however you like (i use `<leader>ss` for `:Docstring`).
2933

0 commit comments

Comments
 (0)