Fixing CI errors 2

Author: Sarra Nebli

janitor/functions/adorn.py

@@ -183,47 +183,22 @@ def adorn_percentages(
     df, col1, col2, axis="row", fmt=True, include_ns=False, decimal_places=1
 ):
     """
-     Adds percentages to a crosstab generated by tabyl, with options to format
-     and include raw counts, and also control the behavior
-         of adorn_pct_formatting and adorn_ns.
-
-     :param df: DataFrame used to generate the crosstab
-     :param col1: First column to create the crosstab
-     :param col2: Second column to create the crosstab
-     :param axis: 'row' to add percentages by row, 'col' for column percentages,
-          'all' for global percentages
-     :param fmt: If True, formats percentages as strings
-         (e.g., "12.5%"), else returns numeric values.
-     :param include_ns: If True, includes raw counts alongside percentages.
-     :param decimal_places: Number of decimal places for the percentages
-     :param thousand_separator: Whether to add a thousand separator to the counts
-     :param percent_format: Whether to format as percentages
-     :return: DataFrame with percentages and optional formatting and raw counts
-
-      Example:
-    Example:
-         >>> data = {
-         ...     "Category": ["A", "B", "A", "B", "A", "B"],
-         ...     "Subcategory": ["X", "X", "Y", "Y", "X", "X"],
-         ...     "Value": [1, 2, 3, 4, 5, 6],
-         ... }
-         >>> df = pd.DataFrame(data)
-
-         >>> result = adorn_percentages(df, col1="Category",
-         ...     col2="Subcategory", axis="row", fmt=True, include_ns=True)
-
-         >>> print(result)
-             Category  X            Y
-             A         20% (1)      80% (4)
-             B         33.33% (2)   66.67% (4)
-
-          >>> result = adorn_percentages(df, col1="Category",
-          ...    col2="Subcategory", axis="col", fmt=True)
-
-         >>> print(result)
-             Category  X            Y
-             A         33.33% (1)   50% (3)
-             B         66.67% (2)   50% (3)
+    Adds percentages to a crosstab generated by tabyl, with options to format
+    and include raw counts, and also control the behavior
+        of adorn_pct_formatting and adorn_ns.
+
+    :param df: DataFrame used to generate the crosstab
+    :param col1: First column to create the crosstab
+    :param col2: Second column to create the crosstab
+    :param axis: 'row' to add percentages by row, 'col' for column percentages,
+         'all' for global percentages
+    :param fmt: If True, formats percentages as strings
+        (e.g., "12.5%"), else returns numeric values.
+    :param include_ns: If True, includes raw counts alongside percentages.
+    :param decimal_places: Number of decimal places for the percentages
+    :param thousand_separator: Whether to add a thousand separator to the counts
+    :param percent_format: Whether to format as percentages
+    :return: DataFrame with percentages and optional formatting and raw counts
 
     """
     # Generate the crosstab using tabyl with the two specified columns