Skip to content

Use raw docstrings instead of escaping backslashes#14332

Merged
dstansby merged 1 commit into
matplotlib:masterfrom
timhoffm:raw-docstrings
May 27, 2019
Merged

Use raw docstrings instead of escaping backslashes#14332
dstansby merged 1 commit into
matplotlib:masterfrom
timhoffm:raw-docstrings

Conversation

@timhoffm
Copy link
Copy Markdown
Member

PR Summary

Note: I would like to enforce pydocstyle D301 on this, but we have several cases of backslash as line continuation which would give false-positives. For now, we cannot check this automatically.

Comment thread lib/matplotlib/ticker.py Outdated
Comment thread lib/matplotlib/colors.py Outdated
@timhoffm timhoffm force-pushed the raw-docstrings branch 2 times, most recently from cbf8cd8 to aead749 Compare May 26, 2019 19:20
@QuLogic
Copy link
Copy Markdown
Member

QuLogic commented May 26, 2019

but we have several cases of backslash as line continuation which would give false-positives.

That seems like a bug in pydocstyle that should be reported to them.

@timhoffm
Copy link
Copy Markdown
Member Author

Already done: PyCQA/pydocstyle#364

@dstansby dstansby added this to the v3.2.0 milestone May 27, 2019
@dstansby dstansby merged commit 30354dd into matplotlib:master May 27, 2019
@timhoffm timhoffm deleted the raw-docstrings branch May 27, 2019 14:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants