Added a docstring.

muddi900 · Aug 1, 2024 · e53e362 · e53e362
1 parent 0040e69
commit e53e362
Showing 1 changed file with 14 additions and 0 deletions.
diff --git a/gspread/worksheet.py b/gspread/worksheet.py
@@ -2611,6 +2611,20 @@ def batch_merge(
         merges: List[Dict[Literal["range", "mergeType"], Union[str | MergeType]]],
         merge_type: MergeType = MergeType.all,
     ) -> Any:
+        """Merge multiple ranges at the same time.
+
+        :param merges: list of dictionaries with the ranges(is A1-notation), and
+            an optional ``MergeType`` field.
+            See `MergeType`_ in the Sheets API reference.
+        :type merges: List[Dict[Literal["range", "mergeType"], Union[str | MergeType]]]
+        :params merge_type: (optional) default ``MergeType`` for all merges missing the merges.
+            defaults to ``MergeType.all``.
+        :type merge_type: ``MergeType``
+
+        :returns: The body of the request repsonse.
+        :rtype: dict
+        """
+
         requests = [
             {
                 "merges": {