Skip to content

Commit 5c568d5

Browse files
committed
doc: Adds rdoc comments to Issue.jql and Issue.jql_paged
1 parent 3773421 commit 5c568d5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

lib/jira/resource/issue.rb

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,11 @@ def self.all(client)
8080
result
8181
end
8282

83+
# Get issues using JQL query.
84+
# @param client [JIRA::Client]
85+
# @param jql [String] the JQL query string to search with
86+
# @param options [Hash] Jira API options for the search
87+
# @return [Array<JIRA::Resource::Issue>] or [Integer] total count if max_results is 0
8388
def self.jql(client, jql, options = { fields: nil, max_results: nil, expand: nil, reconcile_issues: nil })
8489
issues = []
8590
total = nil
@@ -97,6 +102,10 @@ def self.jql(client, jql, options = { fields: nil, max_results: nil, expand: nil
97102
options[:max_results]&.zero? ? total : issues
98103
end
99104

105+
# Get paged issues using JQL query.
106+
# @param jql [String] the JQL query string to search with
107+
# @param options [Hash] Jira API options for the search, including next_page_token
108+
# @return [Hash] with format { issues: [JIRA::Resource::Issue], next_page_token: [String], total: [Integer] }
100109
def self.jql_paged(client, jql, options = { fields: nil, max_results: nil, expand: nil, reconcile_issues: nil, next_page_token: nil })
101110
url = jql_url(client, jql, options)
102111
next_page_token = options[:next_page_token]

0 commit comments

Comments
 (0)