From 9c4a90393822abd3b7a86f64e3db384788adcca7 Mon Sep 17 00:00:00 2001 From: Matt Davis Date: Sun, 3 Jan 2016 15:02:39 -0800 Subject: [PATCH] Point to alternative formats for docstrings The default Sphinx style for docstrings is hard to remember and not especially legible (unless rendered). Multiple friendlier alternatives exist, including the popular NumPy and Google formats, both of which can be rendered by the Sphinx Napoleon extension that is included with Sphinx. --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index babaf4c..427d75f 100644 --- a/README.md +++ b/README.md @@ -315,6 +315,8 @@ def get(url, qsargs=None, timeout=5.0): return request('get', url, qsargs=qsargs, timeout=timeout) ``` +While this is the default Sphinx-style for docstrings, [more legible alternatives exist](http://sphinx-doc.org/ext/napoleon.html). + Don't document for the sake of documenting. The way to think about this is: ```python