Skip to content

Commit 47c5c45

Browse files
committed
Update module docstrings for clarity and context
Expanded the docstrings in simulate.py and statistics.py to provide more detailed descriptions of their purposes and functionalities, improving documentation for users and developers working with connectivity analysis.
1 parent 3e31c94 commit 47c5c45

File tree

2 files changed

+14
-2
lines changed

2 files changed

+14
-2
lines changed

spectral_connectivity/simulate.py

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,9 @@
1-
"""Functions to simulate processes."""
1+
"""Functions to simulate time series processes for connectivity analysis.
2+
3+
This module provides functions for generating synthetic time series data
4+
following various dynamical models, primarily multivariate autoregressive
5+
(MVAR) processes commonly used for testing connectivity methods.
6+
"""
27

38
from typing import Optional, Union
49

spectral_connectivity/statistics.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,11 @@
1-
"""Common statistical procedures used with frequency domain measures."""
1+
"""Statistical procedures for connectivity analysis.
2+
3+
This module provides statistical functions for testing significance of
4+
connectivity measures, including multiple comparison corrections and
5+
transforms for coherence-based measures. Functions support both parametric
6+
and non-parametric approaches for statistical inference in frequency domain
7+
connectivity analysis.
8+
"""
29

310
from typing import Callable, Dict, Literal, Tuple, Union
411

0 commit comments

Comments
 (0)