From 6e0d0e878d4a2a5b65267c3a0e42510af48b8551 Mon Sep 17 00:00:00 2001 From: Brandon Butler Date: Tue, 8 Dec 2020 11:36:31 -0500 Subject: [PATCH] Remove :members: and from TypeParameter and add docstring --- hoomd/data/typeparam.py | 4 ++++ sphinx-doc/module-hoomd-data.rst | 3 +-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/hoomd/data/typeparam.py b/hoomd/data/typeparam.py index 6a4750da77..3af85b49e4 100644 --- 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 index 05e1592069..1f789096fd 100644 --- 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