update docstrings

Author: jerubball

atlassian/jira.py

@@ -3966,12 +3966,12 @@ def get_priority_by_id(self, priority_id: T_id) -> T_resp_json:
 
     def get_autocomplete_data(self) -> T_resp_json:
         """
-        Returns full information about visible fields that can be used in JQL.
+        Returns full information about visible fields that can be autocompleted in JQL.
 
         Available in Jira Data Center, Jira Cloud v2, Jira Cloud v3.
 
-        Reference: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-jql/#api-group-jql
-                   https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-group-jql
+        Reference: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-jql/#api-api-2-jql-autocompletedata-get
+                   https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-rest-api-2-jql-autocompletedata-get
         :return:
         """
         url = self.resource_url("jql/autocompletedata")
@@ -3994,6 +3994,12 @@ def get_autocomplete_suggestion(
             `fieldName` and `predicateName` to get a list of all predicate values for the field.
             `fieldName`, `predicateName`, and `predicateValue` to get a list of predicate values containing the text in `predicateValue`.
 
+        Although auto complete suggestion can be used to retrieve possible option for a field,
+        it may be more appropriate to use `get_custom_field_options()` method to get project-specific options for a field.
+
+        Reference: https://developer.atlassian.com/server/jira/platform/rest/v11003/api-group-jql/#api-api-2-jql-autocompletedata-suggestions-get
+                   https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-jql/#api-rest-api-2-jql-autocompletedata-suggestions-get
+
         :param field_name: str, Optional - The field name for which the suggestions are generated.
         :param field_value: str, Optional - The portion of the field value that has already been provided by the user.
         :param predicate_name: str, Optional - The predicate for which the suggestions are generated. Suggestions are generated only for: "by", "from" and "to".

docs/jira.rst

@@ -467,6 +467,13 @@ Epic Issues
     # By default, the returned issues are ordered by rank.
     jira.get_issues_for_epic(board_id, epic_id, jql="", validate_query="", fields="*all", expand="", start=0, limit=50, )
 
+    # Returns full information about visible fields that can be autocompleted in JQL.
+    jira.get_autocomplete_data()
+
+    # Returns auto complete suggestions for JQL search.
+    field_name = "Custom Field"
+    jira.get_autocomplete_suggestion(field_name, field_value=None, predicate_name=None, predicate_value=None)
+
 Manage Boards
 -------------