Skip to content

Fix tweak doc #117

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 5, 2020
Merged

Fix tweak doc #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 3 additions & 4 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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::

Expand Down Expand Up @@ -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::
Expand Down
3 changes: 1 addition & 2 deletions doc/pydocstring.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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*
Expand Down