Added docs for bulk_update_issue_field method. Fix docstring.

atlassian-api · May 20, 2024 · 32acc4f · 32acc4f
1 parent b9f15dc
commit 32acc4f
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/atlassian/jira.py b/atlassian/jira.py
@@ -1320,7 +1320,7 @@ def update_issue_field(self, key, fields="*all", notify_users=True):
 
     def bulk_update_issue_field(self, key_list, fields="*all"):
         """
-        :param key_list=list of issues with common filed to be updated
+        :param key_list: list of issues with common filed to be updated
         :param fields: common fields to be updated
         return Boolean True/False
         """

diff --git a/docs/jira.rst b/docs/jira.rst
@@ -228,6 +228,9 @@ Manage issues
     fields = {'summary': 'New summary'}
     jira.update_issue_field(key, fields, notify_users=True)
 
+    # Bulk update issue field
+    jira.bulk_update_issue_field(key_list, fields="*all")
+
     # Append value to issue field
     field = 'customfield_10000'
     value = {'name': 'username'}