Skip to content

Commit b14ef92

Browse files
committed
Updated README.srt
Made it more clear that doq's path needs to be set, and fixed a spelling mistake.
1 parent 1d387a4 commit b14ef92

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

README.rst

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,11 @@ If you want install doq manually, you can install from PyPi.
3939
$ python3 -m venv ./venv
4040
$ ./venv/bin/pip3 install doq
4141
42-
Then set installed `doq <https://pypi.org/project/doq/>`_ path to `g:pydocstring_doq_path`.
42+
Then set installed `doq <https://pypi.org/project/doq/>`_ path:
43+
44+
.. code::
45+
$ which doq
46+
g:pydocstring_doq_path
4347
4448
Note
4549
~~~~
@@ -82,7 +86,7 @@ If you want change default keymapping, set following to your `.vimrc`.
8286
8387
nmap <silent> <C-_> <Plug>(pydocstring)
8488
85-
Foramtter
89+
Formatter
8690
---------
8791

8892
You can set built-in formatter(Sphinx, Numpy, Google).

0 commit comments

Comments
 (0)