Skip to content

Commit 9a36655

Browse files
committed
Add settings and keymap.
1 parent d2c416b commit 9a36655

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,25 @@ Pydocstring is a generator for Python docstrings and is capable of automatically
1010
This plugin is heavily inspired by [phpdoc.vim](http://www.vim.org/scripts/script.php?script_id=1355) and [sonictemplate.vim](https://github.com/mattn/sonictemplate-vim).
1111

1212
Usage
13+
-----
1314

1415
1. Move your cursor on a `def` or `class` keyword line,
1516
1. type `:Pydocstring` or enter `<C-l>` (default keymapping) and
1617
1. watch a docstring template magically appear below the current line
18+
19+
Settings
20+
--------
21+
Pydocstring need depends on `softtabstop`.
22+
23+
```viml
24+
autocmd FileType python setlocal tabstop=4 shiftwidth=4 softtabstop=4 expandtab
25+
```
26+
27+
Key map
28+
-------
29+
30+
If you want change default keymapping, set following to your `.vimrc`.
31+
32+
```viml
33+
nmap <silent> <C-_> <Plug>(pydocstring)
34+
```

0 commit comments

Comments
 (0)