docs: add docstrings

src/dcnum/feat/__init__.py

@@ -1,4 +1,5 @@
 # flake8: noqa: F401
+"""Feature computation"""
 from . import feat_background, feat_brightness, feat_moments, feat_texture
 from .event_extractor_manager_thread import EventExtractorManagerThread
 from .queue_event_extractor import (

src/dcnum/feat/event_extractor_manager_thread.py

@@ -1,3 +1,4 @@
+"""Feature computation: managing event extraction threads"""
 import logging
 import multiprocessing as mp
 import threading

src/dcnum/feat/feat_background/__init__.py

@@ -1,4 +1,5 @@
 # flake8: noqa: F401
+"""Feature computation: background image data from image data"""
 from .base import Background, get_available_background_methods
 # Background methods are registered by importing them here.
 from .bg_roll_median import BackgroundRollMed

src/dcnum/feat/feat_brightness/__init__.py

@@ -1,3 +1,4 @@
 # flake8: noqa: F401
+"""Feature computation: brightness-based features"""
 from .bright_all import brightness_features
 from .common import brightness_names

src/dcnum/feat/feat_moments/__init__.py

@@ -1,3 +1,4 @@
 # flake8: noqa: F401
+"""Feature computation: OpenCV moments-based features"""
 from .mt_legacy import moments_based_features
 

src/dcnum/feat/feat_texture/__init__.py

@@ -1,2 +1,3 @@
 # flake8: noqa: F401
+"""Feature computation: Haralick texture features"""
 from .tex_all import haralick_names, haralick_texture_features

src/dcnum/feat/gate.py

@@ -1,3 +1,4 @@
+"""Feature computation: gating after feature extraction"""
 import copy
 import warnings
 

src/dcnum/feat/queue_event_extractor.py

@@ -1,3 +1,4 @@
+"""Feature Extraction: event extractor worker"""
 import collections
 import logging
 from logging.handlers import QueueHandler

src/dcnum/write/deque_writer_thread.py

@@ -19,7 +19,7 @@ def __init__(self,
         ----------
         path_out:
             Path to the output HDF5 file
-        dq:
+        dq: collections.deque
             `collections.deque` object from which data are taken
             using `popleft()`.
         """