Updates #2053 [Napoleon] Updates documentation to indicate napoleon_include_special_with_doc = True by default

1 files changed, 5 insertions, 4 deletions

diff --git a/doc/ext/example_numpy.py b/doc/ext/example_numpy.py
index 68bc9d289..bb91cac82 100644
--- a/doc/ext/example_numpy.py
+++ b/doc/ext/example_numpy.py
@@ -286,16 +286,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