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

Support ur"""docstrings""" #116

Closed
jquast opened this issue Apr 14, 2015 · 0 comments · Fixed by #119
Closed

Support ur"""docstrings""" #116

jquast opened this issue Apr 14, 2015 · 0 comments · Fixed by #119

Comments

@jquast
Copy link

@jquast jquast commented Apr 14, 2015

I have a docstring that contains both unicode characters and backslashes.

I cannot find any way to make the pep257 happy with this, though ur"""docstring""" seems suitable.

$ cat > test.py <<EOF
"""Some test module."""
# encoding: utf-8

def func(self):
    ur"""docstring with \backslashes and unicode, コンニチハ."""
    pass
EOF
$ pep257 test.py
test.py:4 in public function `func`:
        D301: Use r""" if any backslashes in a docstring
test.py:4 in public function `func`:
        D300: Use """triple double quotes""" (found '-quotes)
$ PAGER=cat python
>>> from test import func
>>> help(func)
Help on function func in module test:

func(self)
    docstring with \backslashes and unicode, コンニチハ.

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

Successfully merging a pull request may close this issue.

1 participant