<commit_before>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](http://www.vim.org/scripts/script.php?script_id=1355) and [sonictemplate.vim](https://github.com/mattn/sonictemplate-vim).

Usage
-----

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

Settings
--------
Pydocstring depends on `softtabstop`.

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

Key map
-------

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

```viml
nmap <silent> <C-_> <Plug>(pydocstring)
```
<commit_msg>Add more detail.<commit_after>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](http://www.vim.org/scripts/script.php?script_id=1355) and [sonictemplate.vim](https://github.com/mattn/sonictemplate-vim).

Usage
-----

  1. Move your cursor on a `def` or `class` keyword line,
  1. type `:Pydocstring` or enter `<C-l>` (default keymapping) and
  1. 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`

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

Key map
-------

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

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

{'fraction_non_alphanumeric': 0.1342567927543953, 'fraction_numerical': 0.011188066062866276, 'mean_word_length': 4.305084745762712, 'pattern_counts': {'":': 0, '<': 11, '<?xml version=': 0, '>': 11, 'https://': 2, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1706352', 'n_tokens_mistral': 630, 'n_tokens_neox': 576, 'n_words': 199}