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.

Sign up for GitHub

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

Jump to bottom

Add example for bad-docstring-quotes message documentation #6150

Closed
wants to merge 5 commits into from
Closed

Add example for bad-docstring-quotes message documentation #6150

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
60c206c
add example for `bad-docstring-quotes`
gunungpw Apr 2, 2022
29e4297
remove pass
gunungpw Apr 3, 2022
3b06bf6
[pre-commit.ci] auto fixes from pre-commit.com hooks
pre-commit-ci[bot] Apr 3, 2022
91dc6e1
Update related.rst
gunungpw Apr 3, 2022
33a560f
Update doc/data/messages/b/bad-docstring-quotes/bad.py
Pierre-Sassoulas Apr 3, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions doc/data/messages/b/bad-docstring-quotes/bad.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# fmt: off
def square_root():
'''Return the square root of input.''' # [bad-docstring-quotes]
# fmt: on
Pierre-Sassoulas marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 2 additions & 0 deletions doc/data/messages/b/bad-docstring-quotes/good.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
def square_root():
"""Return the square root of input."""
2 changes: 2 additions & 0 deletions doc/data/messages/b/bad-docstring-quotes/related.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
* `PEP 8 - Style Guide for Python Code <https://peps.python.org/pep-0008/>`_
* `PEP 257 - Docstring Conventions <https://peps.python.org/pep-0257/>`_