summaryrefslogtreecommitdiff
path: root/doc/ext/example_google.py
diff options
context:
space:
mode:
authorRob Ruana <rob@robruana.com>2015-11-17 20:13:55 -0800
committerRob Ruana <rob@robruana.com>2015-11-17 20:13:55 -0800
commite926ebb263435b3a6ea2c57ddddd3eae4bd2a7d6 (patch)
treeb1a7ddb8e885dce50c432dba8b8e13ec6e87b914 /doc/ext/example_google.py
parent4061e3244d5ebd93d6dd71f1e979629dbf760333 (diff)
downloadsphinx-git-e926ebb263435b3a6ea2c57ddddd3eae4bd2a7d6.tar.gz
Updates #2053 [Napoleon] Updates documentation to indicate napoleon_include_special_with_doc = True by default
Diffstat (limited to 'doc/ext/example_google.py')
-rw-r--r--doc/ext/example_google.py9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/ext/example_google.py b/doc/ext/example_google.py
index bc0fd5569..81a312cfd 100644
--- a/doc/ext/example_google.py
+++ b/doc/ext/example_google.py
@@ -241,16 +241,17 @@ class ExampleClass(object):
return True
def __special__(self):
- """By default special members with docstrings are included.
+ """By default special members with docstrings are not included.
Special members are any methods or attributes that start with and
end with a double underscore. Any special member with a docstring
- will be included in the output.
+ will be included in the output, if
+ ``napoleon_include_special_with_doc`` is set to True.
- This behavior can be disabled by changing the following setting in
+ This behavior can be enabled by changing the following setting in
Sphinx's conf.py::
- napoleon_include_special_with_doc = False
+ napoleon_include_special_with_doc = True
"""
pass