commit f99633ca62766f1f1c123132a75b745e255d26c4 Author: Damian Johnson atagar@torproject.org Date: Wed May 13 15:56:07 2020 -0700
Drop explicit __init__ from automodule
The only visible difference I can see between including '__init__' verses excluding it for automodule declarations is class names. If we include it the page cites classes as...
stem.descriptor.__init__.DigestHash
... whereas without it the page renders...
stem.descriptor.DigestHash
The second is obviously correct so dropping the suffix. --- docs/api/descriptor/descriptor.rst | 2 +- docs/api/util/init.rst | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/docs/api/descriptor/descriptor.rst b/docs/api/descriptor/descriptor.rst index 0273b535..b5b642c6 100644 --- a/docs/api/descriptor/descriptor.rst +++ b/docs/api/descriptor/descriptor.rst @@ -1,5 +1,5 @@ Descriptor ==========
-.. automodule:: stem.descriptor.__init__ +.. automodule:: stem.descriptor
diff --git a/docs/api/util/init.rst b/docs/api/util/init.rst index fae27191..651826f0 100644 --- a/docs/api/util/init.rst +++ b/docs/api/util/init.rst @@ -1,5 +1,5 @@ Util ====
-.. automodule:: stem.util.__init__ +.. automodule:: stem.util