Skip to content

Commit 17cf47e

Browse files
authored
Fix doc (#116)
1 parent ae854d0 commit 17cf47e

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

README.rst

+5
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,11 @@ You can install following command.
2424
2525
$ make install
2626
27+
Note
28+
~~~~
29+
30+
If you using venv or virtualenv, you may deactivate venv/virtualenv first.
31+
doq will create own venv.
2732

2833
This can be automated with vim-plug. Activated venv needs to be deactivated before running `PlugInstall` or `PlugUpdate`.
2934

doc/pydocstring.txt

+3
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,9 @@ If you want install `doq` manually, you can install from `PyPi`.
5050
<
5151
Than set installed `doq` path to |g:pydocstring_doq_path|.
5252

53+
If you using venv or virtualenv, you may deactivate venv/virtualenv first.
54+
doq will create own venv.
55+
5356
==============================================================================
5457
TUTORIAL *pydocstring-vim-tutorial*
5558

0 commit comments

Comments
 (0)