Skip to content
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.

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

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

Conversation

fulopkovacs
Copy link
Contributor

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 heavenshell merged commit ebfef04 into heavenshell:master Jun 8, 2020
@heavenshell
Copy link
Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants