File tree Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Expand file tree Collapse file tree 1 file changed +6
-4
lines changed Original file line number Diff line number Diff line change @@ -33,8 +33,7 @@ This can be automated with vim-plug.
3333
3434.. code ::
3535
36- Plug 'heavenshell/vim-pydocstring', { 'do': 'make install' }
37-
36+ Plug 'heavenshell/vim-pydocstring', { 'do': 'make install', 'for': 'python' }
3837
3938 If you want install doq manually, you can install from PyPi.
4039
@@ -47,8 +46,8 @@ Then set installed `doq <https://pypi.org/project/doq/>`_ path:
4746
4847.. code ::
4948
50- $ which doq
51- g:pydocstring_doq_path
49+ $ which doq
50+ let g:pydocstring_doq_path = path/to/doq
5251
5352 Note
5453~~~~
@@ -73,6 +72,7 @@ type `:PydocstringFormat` will insert all docstrings to current buffer.
7372
7473Settings
7574--------
75+
7676Pydocstring depends on ``shiftwidth `` if ``smarttab `` is set, otherwise
7777``softtabstop ``. For the latter, you need to set like ``set softtabstop=4 ``.
7878
8888
8989 autocmd FileType python setlocal tabstop=4 shiftwidth=4 softtabstop=4 expandtab
9090
91+ Pydocstring use ftplugin, so `filetype plugin on ` required.
92+
9193Key map
9294-------
9395
You can’t perform that action at this time.
0 commit comments