From a66bf43829b35b4d63386ff1389744d372c5ae86 Mon Sep 17 00:00:00 2001
From: xingzhongyu <xzy12386@163.com>
Date: Wed, 18 Dec 2024 11:31:10 +0800
Subject: [PATCH] add note

---
 dance/transforms/filter.py | 14 ++++++++++++++
 1 file changed, 14 insertions(+)

diff --git a/dance/transforms/filter.py b/dance/transforms/filter.py
index 8ec0ac1f..ef703d0d 100644
--- a/dance/transforms/filter.py
+++ b/dance/transforms/filter.py
@@ -274,6 +274,20 @@ def __init__(
 @register_preprocessor("filter", "cell")
 @add_mod_and_transform
 class FilterCellsCommonMod(BaseTransform):
+    """Initialize the FilterCellsCommonMod class.
+
+    Parameters
+    ----------
+    mod1 : str
+        Name of the first modality in the single-cell dataset.
+    mod2 : str
+        Name of the second modality in the single-cell dataset.
+    sol : Optional[str], default=None
+        Name of the optional solution dataset containing cell labels or annotations.
+    **kwargs : dict
+        Additional keyword arguments passed to the base transformation class.
+
+    """
 
     def __init__(self, mod1: str, mod2: str, sol: Optional[str] = None, **kwargs):
         super().__init__(**kwargs)