From c69b0bb102030bf69c6bed543ffd2597827c9d95 Mon Sep 17 00:00:00 2001 From: Carlo DiCelico Date: Wed, 3 Feb 2016 09:27:51 -0500 Subject: [PATCH] Update docstrings section ReStructured Text is typically abbreviated as RST, not reST, so I've changed that here since reST is too much like REST. I've also added a parenthetical spelling out what RST stands for for clarity and fixed the indentation in the code sample. --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 7c4fe5b..132e0fe 100644 --- a/README.md +++ b/README.md @@ -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): @@ -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: