Skip to content

Update docstrings section for clarity and fix code sample indentation #28

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update docstrings section for clarity and fix code sample indentation #28

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
6 changes: 3 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -301,7 +301,7 @@ This is perhaps the ultimate nitpick, but if you don't do it, it will drive peop

## Writing Good Docstrings

Here's a quick reference to using Sphinx-style reST in your function docstrings:
Here's a quick reference to using Sphinx-style RST (ReStructured Text) in your function docstrings:

```python
def get(url, qsargs=None, timeout=5.0):
Expand All @@ -313,8 +313,8 @@ def get(url, qsargs=None, timeout=5.0):
:type qsargs: dict
:param timeout: In seconds.
:rtype: mymodule.Response
"""
return request('get', url, qsargs=qsargs, timeout=timeout)
"""
return request('get', url, qsargs=qsargs, timeout=timeout)
```

Don't document for the sake of documenting. The way to think about this is:
Expand Down