Better docstring for Component

cta-observatory · Nov 23, 2023 · dce6421 · dce6421
1 parent 54659cb
commit dce6421
Showing 1 changed file with 10 additions and 2 deletions.
diff --git a/ctapipe/core/component.py b/ctapipe/core/component.py
@@ -201,8 +201,16 @@ def from_name(cls, name, config=None, parent=None, **kwargs):
     @classmethod
     def non_abstract_subclasses(cls):
         """
-        get dict{name: cls} of non abstract subclasses,
-        subclasses can possibly be defined in plugins
+        Get a dict of all non-abstract subclasses of this class.
+
+        This method is using the entry-point plugin system
+        to also check for registered plugin implementations.
+
+        Returns
+        -------
+        subclasses : dict[str, type]
+            A dict mapping the name to the class of all found,
+            non-abstract  subclasses of this class.
         """
         if hasattr(cls, "plugin_entry_point"):
             detect_and_import_plugins(cls.plugin_entry_point)