Skip to content

Commit 01913bf

Browse files
committed
Change Markdown to reStructuredText.
1 parent 391c0d9 commit 01913bf

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md renamed to README.rst

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -7,14 +7,14 @@ Pydocstring is a generator for Python docstrings and is capable of automatically
77
* inserting multi-line docstrings
88
* inserting comments
99

10-
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).
10+
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
1313
-----
1414

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

1919
Settings
2020
--------
@@ -23,15 +23,15 @@ You need to set like `set softtabstop=4`.
2323

2424
Example `.vimrc`
2525

26-
```viml
27-
autocmd FileType python setlocal tabstop=4 shiftwidth=4 softtabstop=4 expandtab
28-
```
26+
.. code::
27+
28+
autocmd FileType python setlocal tabstop=4 shiftwidth=4 softtabstop=4 expandtab
2929
3030
Key map
3131
-------
3232

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

35-
```viml
36-
nmap <silent> <C-_> <Plug>(pydocstring)
37-
```
35+
.. code::
36+
37+
nmap <silent> <C-_> <Plug>(pydocstring)

0 commit comments

Comments
 (0)