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

Docstring that ends with""" rather than \n""" completely breaks rendering #120

Open
Pet3ris opened this issue Sep 17, 2021 · 0 comments
Open
Labels

Comments

@Pet3ris
Copy link

Pet3ris commented Sep 17, 2021

Hi There,

Thanks for this awesome tool. Running into an issue where these docstrings break rendering:

def add(x, y):
  """This should be a simple docstring
  However, it turns everything following it into a comment."""
  return x + y

Only this works:

def add(x, y):
  """This should be a simple docstring
  However, it turns everything following it into a comment.
  """
  return x + y

Given this particular formatting is not picked up on by pylint, I assume it is valid and this is a bug.

@subsetpark subsetpark added the bug label Sep 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants