Skip to content
This repository was archived by the owner on Nov 3, 2023. It is now read-only.
This repository was archived by the owner on Nov 3, 2023. It is now read-only.

Support ur"""docstrings""" #116

@jquast

Description

@jquast

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

>>>

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions