Merge pull request #41 from wanunulab/docs/add-docstrings-and-type-hints

Add docstrings and type hints across all modules

Author: a-fa

.gitignore

@@ -171,4 +171,3 @@ src/ionique/cparsers.c
 src/ionique/_version.py
 
 
-

src/ionique/__init__.py

@@ -1,4 +1,38 @@
 #!/usr/bin/env python
+"""
+ionique: modular nanopore signal analysis framework for ionic current data.
+
+Submodules
+----------
+core
+    Segment tree hierarchy (AbstractSegmentTree, MetaSegment, Segment) for
+    organizing and recursively parsing ionic current signal data. core is rarely imported by the user. 
+datatypes
+    Data containers including TraceFile for wrapping loaded traces and
+    SessionFileManager (singleton) for managing a session's loaded files.
+io
+    File readers for nanopore data formats: EDH, OPT, and ABF. Handles
+    loading, metadata extraction, and unit scaling.
+utils
+    Signal processing utilities such as filters and feature extraction helpers.
+    
+parsers
+    Event detection parsers (SpikeParser, AutoSquareParser) that operate on
+    Segment trees and produce child segments for detected events.
+plotting
+    Bokeh-based visualization functions and Panel-based interactive
+    dashboards for exploring nanopore traces.
+simple
+    GUI/Jupyter convenience functions and Panel widgets for file loading and
+    parser configuration, intended for non-programmatic use.
+
+Notes
+-----
+``__version__`` is auto-generated from the package metadata by
+setuptools-scm and exposed here so callers can inspect it via
+``ionique.__version__``.  Falls back to ``"0.0.0"`` when the generated
+``_version.py`` file is absent (e.g. in an uninstalled source tree).
+"""
 import ionique.core as core
 import ionique.datatypes as datatypes
 import ionique.io as io