Skip to content

Fixed example docstring #752

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

Merged
kennethreitz merged 1 commit into from
Oct 31, 2016
Merged

Fixed example docstring #752

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/writing/documentation.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ In Python, *docstrings* describe modules, classes, and functions:
.. code-block:: python

def square_and_rooter(x):
"""Returns the square root of self times self."""
"""Return the square root of self times self."""
...

In general, follow the comment section of :pep:`8#comments` (the "Python Style
Expand Down