🐛 update docstrings to correct types

Multiomics-Analytics-Group · Dec 2, 2024 · b1643a9 · b1643a9
1 parent 4adc624
commit b1643a9
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/acore/enrichment_analysis.py b/acore/enrichment_analysis.py
@@ -244,12 +244,12 @@ def _annotate_features(
     Annotate features as foreground or background based on their presence in the
     foreground and background lists.
 
-    :param features: pandas dataframe with features and their annotations.
+    :param features: pandas.Series with features and their annotations.
     :param in_foreground: list of features identifiers in the foreground.
     :type in_foreground: set or list-like
     :param in_background: list of features identifiers in the background.
     :type in_background: set or list-like
-    :return: pandas dataframe with a new column 'group' containing 'foreground' or 'background'.
+    :return: pandas.Series containing 'foreground' or 'background'.
              missing values are preserved.
 
     Example::