Remove :members: and from TypeParameter and add docstring

glotzerlab · Dec 8, 2020 · 6e0d0e8 · 6e0d0e8
1 parent 77b57b0
commit 6e0d0e8
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/hoomd/data/typeparam.py b/hoomd/data/typeparam.py
@@ -2,6 +2,10 @@
 
 
 class TypeParameter:
+    """Store information that is per-type.
+
+    Provides a `collections.abc.MutableMapping` interface.
+    """
     def __init__(self, name, type_kind, param_dict):
         self.name = name
         self.type_kind = type_kind

diff --git a/sphinx-doc/module-hoomd-data.rst b/sphinx-doc/module-hoomd-data.rst
@@ -38,8 +38,7 @@ hoomd.data
         :inherited-members:
 
     .. autoclass:: hoomd.data.typeparam.TypeParameter
-        :members: default, keys
-        :undoc-members:
+        :members: default
 
 .. rubric:: Modules