PyCQA / pydocstyle

docstring style checker
http://pydocstyle.org
MIT License
1.11k stars 188 forks source link

`D300` and `D301` false positives on docstrings with escaped triple quotes in them #643

Open DetachHead opened 1 year ago

DetachHead commented 1 year ago
def foo():
    """
    here's how to make a docstring: `\"\"\"`
    """
Use """triple double quotes""" (found """-quotes) (D300)
Use r""" if any backslashes in a docstring (D301)

adding r to the string causes it to render incorrectly, with the backslashes: image image