From d9bbda4612eefaf8956719edbe68ee35d81dc06f Mon Sep 17 00:00:00 2001 From: Shinya Ohyanagi Date: Sat, 5 Dec 2020 23:18:08 +0900 Subject: [PATCH] Fix tweak doc --- README.rst | 7 +++---- doc/pydocstring.txt | 3 +-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 24613e3..33e923f 100644 --- a/README.rst +++ b/README.rst @@ -27,10 +27,9 @@ You can install following command. Note ~~~~ -If you using venv or virtualenv, you may deactivate venv/virtualenv first. -doq will create own venv. +Activated venv needs to be deactivated before insatll doq. -This can be automated with vim-plug. Activated venv needs to be deactivated before running `PlugInstall` or `PlugUpdate`. +This can be automated with vim-plug. .. code:: @@ -121,7 +120,7 @@ Exceptions ---------- If you want add exceptions to docstring, create custom template -and visual select source block and hit `:'<,'>Pydocstring` and then +and visual select source block and hit `:'<,'>Pydocstring` and then excptions add to docstring. .. code:: diff --git a/doc/pydocstring.txt b/doc/pydocstring.txt index 70b007c..c17fccd 100644 --- a/doc/pydocstring.txt +++ b/doc/pydocstring.txt @@ -50,8 +50,7 @@ If you want install `doq` manually, you can install from `PyPi`. < Than set installed `doq` path to |g:pydocstring_doq_path|. -If you using venv or virtualenv, you may deactivate venv/virtualenv first. -doq will create own venv. +Activated venv needs to be deactivated before insatll doq. ============================================================================== TUTORIAL *pydocstring-vim-tutorial*