From b4cc9d3f537907756a1ab893e3cbb7e15ecd371c Mon Sep 17 00:00:00 2001 From: Shinya Ohyanagi Date: Fri, 21 May 2021 23:22:43 +0900 Subject: [PATCH] Fix filetype on --- README.rst | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index 33e923f..73460ae 100644 --- a/README.rst +++ b/README.rst @@ -33,8 +33,7 @@ This can be automated with vim-plug. .. code:: - Plug 'heavenshell/vim-pydocstring', { 'do': 'make install' } - + Plug 'heavenshell/vim-pydocstring', { 'do': 'make install', 'for': 'python' } If you want install doq manually, you can install from PyPi. @@ -47,8 +46,8 @@ Then set installed `doq `_ path: .. code:: - $ which doq - g:pydocstring_doq_path + $ which doq + let g:pydocstring_doq_path = path/to/doq Note ~~~~ @@ -73,6 +72,7 @@ type `:PydocstringFormat` will insert all docstrings to current buffer. Settings -------- + Pydocstring depends on ``shiftwidth`` if ``smarttab`` is set, otherwise ``softtabstop``. For the latter, you need to set like ``set softtabstop=4``. @@ -88,6 +88,8 @@ Or: autocmd FileType python setlocal tabstop=4 shiftwidth=4 softtabstop=4 expandtab +Pydocstring use ftplugin, so `filetype plugin on` required. + Key map -------