Made _process_data docstring more explicit.

python-microscope · Dec 19, 2019 · 1c16359 · 1c16359
1 parent 0c98ba9
commit 1c16359
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/microscope/devices.py b/microscope/devices.py
@@ -495,8 +495,10 @@ def _fetch_data(self):
     def _process_data(self, data):
         """Do any data processing and return data.
 
-        Subclasses should call super()._process_data(data) after doing their
-        own processing."""
+        Subclasses should add their processing to self.pipeline in preference
+        to overriding this method. Anything that overrides this method must
+        call super()_process_data(data) either before or after its own
+        processing."""
         import functools
         return functools.reduce(lambda x, f: f(x), self.pipeline, data)