Support ur"""docstrings""" #116

Closed
jquast opened this Issue Apr 14, 2015 · 0 comments

Projects

None yet

1 participant

@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, コンニチハ.

>>>
@Nurdok Nurdok closed this in #119 Jun 22, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment