Merge pull request #2419 from cta-observatory/fix_eventsource_docstring

Fix docstring of EventSource

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 definded 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)

ctapipe/io/eventsource.py

@@ -50,9 +50,11 @@ class EventSource(Component):
     An ``EventSource`` can also be created through the configuration system,
     by passing ``config`` or ``parent`` as appropriate.
     E.g. if using ``EventSource`` inside of a ``Tool``, you would do:
+
     >>> self.source = EventSource(parent=self) # doctest: +SKIP
 
     To loop through the events in a file:
+
     >>> source = EventSource(input_url="dataset://gamma_prod5.simtel.zst", max_events=2)
     >>> for event in source:
     ...     print(event.count)