Merge pull request #1542 from burnash/doc/add-batch-example

add example for `batch_merge`
burnash · Feb 12, 2025 · 56b0de2 · 56b0de2
2 parents 94617c9 + 7dfd7ab
commit 56b0de2
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/gspread/worksheet.py b/gspread/worksheet.py
@@ -2623,6 +2623,15 @@ def batch_merge(
             defaults to ``MergeType.merge_all``.
         :type merge_type: ``MergeType``
 
+        example::
+
+            worksheet.batch_merge(
+                [
+                    {"range": "A1:M1"},
+                    {"range": "D2:H2", "mergeType": utils.MergeType.merge_rows}
+                ]
+            )
+
         :returns: The body of the request response.
         :rtype: dict
         """