summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNed Batchelder <ned@nedbatchelder.com>2020-01-26 08:33:00 -0500
committerNed Batchelder <ned@nedbatchelder.com>2020-01-26 08:33:00 -0500
commit6644fece3fffc12aa7de24f7e3f9eebc7c109a3d (patch)
tree2b8a71b44b0f9d406b424c43efd1dd6ca1a5a7f6
parentc34567354af2af87d78b32e2fc452c41aca85995 (diff)
downloadpython-coveragepy-git-6644fece3fffc12aa7de24f7e3f9eebc7c109a3d.tar.gz
Correct a comment
-rw-r--r--doc/conf.py4
1 files changed, 2 insertions, 2 deletions
diff --git a/doc/conf.py b/doc/conf.py
index 414a8be4..4227dcb2 100644
--- a/doc/conf.py
+++ b/doc/conf.py
@@ -222,8 +222,8 @@ extlinks = {
'github': ('https://github.com/nedbat/coveragepy/issues/%s', 'issue '),
}
-# When auto-doc'ing a class, write the class' docstring and the __init__ docstring
-# into the class docs.
+# When auto-doc'ing a class, only write the class' docstring into the class docs,
+# don't automatically include the __init__ docstring.
autoclass_content = "class"
prerelease = bool(max(release).isalpha())