search

heavenshell / vim-pydocstring

Generate Python docstring to your Python source code.
BSD 3-Clause "New" or "Revised" License
337 stars 53 forks source link

Fix rst syntax error in README.md to make the instructions about the … #100

Closed fulopkovacs closed 4 years ago

fulopkovacs commented 4 years ago

Fixed a but with the rendering of the README.rst in this PR.

Issue

The instructions on how to configure the path to the doq binary in the .vimrc weren't rendered properly in the README.rst.

Missing part:

   $ which doq
   g:pydocstring_doq_path

I encountered this bug today, but I think the author of this issue has experienced the same problem.

That issue is 9 days old, while the bug has been present for at least 19 days (see this commit)

Cause

A new line character was missing from the README.rst after a code directive and the lines in the code block were interpreted as arguments for the code directive as a result.

Note

By the way, it's a pretty cool plugin, thank you! ☺️

heavenshell commented 4 years ago

oh!!!! Thank you so much!! Nice catch!!