jaume-gasa / vim-pydocstring

Generate Python docstring to your Python script file.

pydocstring.vim

Pydocstring is a generator for Python docstrings and is capable of automatically

• inserting one-line docstrings
• inserting multi-line docstrings
• inserting comments

This plugin is heavily inspired by phpdoc.vim and sonictemplate.vim.

Usage

1. Move your cursor on a def or class keyword line,
2. type :Pydocstring or enter <C-l> (default keymapping) and
3. watch a docstring template magically appear below the current line

Settings

Pydocstring depends on softtabstop. You need to set like set softtabstop=4.

Example .vimrc

autocmd FileType python setlocal tabstop=4 shiftwidth=4 softtabstop=4 expandtab

Activate numpy-style docstrings

let g:pydocstring_templates_dir = '~/.vim/bundle/vim-pydocstring/test/templates/numpy/'

Key map

If you want change default keymapping, set following to your .vimrc.

nmap <silent> <C-_> <Plug>(pydocstring)