From b14ef92cac19168a7b9d2bc52f18bfb460133e88 Mon Sep 17 00:00:00 2001 From: Kristian Nymann Jakobsen Date: Wed, 20 May 2020 11:22:58 +0200 Subject: [PATCH] Updated README.srt Made it more clear that doq's path needs to be set, and fixed a spelling mistake. --- README.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index 03acd12..08d8eb9 100644 --- a/README.rst +++ b/README.rst @@ -39,7 +39,11 @@ If you want install doq manually, you can install from PyPi. $ python3 -m venv ./venv $ ./venv/bin/pip3 install doq -Then set installed `doq `_ path to `g:pydocstring_doq_path`. +Then set installed `doq `_ path: + +.. code:: + $ which doq + g:pydocstring_doq_path Note ~~~~ @@ -82,7 +86,7 @@ If you want change default keymapping, set following to your `.vimrc`. nmap (pydocstring) -Foramtter +Formatter --------- You can set built-in formatter(Sphinx, Numpy, Google).