Skip to content

Commit

Permalink
doc: Fix comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Thiht committed Jun 25, 2018
1 parent fb1ce22 commit 52e8877
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
9 changes: 4 additions & 5 deletions field.go
Original file line number Diff line number Diff line change
@@ -1,14 +1,13 @@
package jira

// PriorityService handles priorities for the JIRA instance / API.
// FieldService handles fields for the JIRA instance / API.
//
// JIRA API docs: https://developer.atlassian.com/cloud/jira/platform/rest/#api-Priority
// JIRA API docs: https://developer.atlassian.com/cloud/jira/platform/rest/#api-Field
type FieldService struct {
client *Client
}

// Priority represents a priority of a JIRA issue.
// Typical types are "Normal", "Moderate", "Urgent", ...
// Field represents a field of a JIRA issue.
type Field struct {
ID string `json:"id,omitempty" structs:"id,omitempty"`
Key string `json:"key,omitempty" structs:"key,omitempty"`
Expand All @@ -27,7 +26,7 @@ type FieldSchema struct {

// GetList gets all fields from JIRA
//
// JIRA API docs: https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-priority-get
// JIRA API docs: https://developer.atlassian.com/cloud/jira/platform/rest/#api-api-2-field-get
func (s *FieldService) GetList() ([]Field, *Response, error) {
apiEndpoint := "rest/api/2/field"
req, err := s.client.NewRequest("GET", apiEndpoint, nil)
Expand Down
2 changes: 1 addition & 1 deletion field_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ func TestFieldService_GetList(t *testing.T) {

fields, _, err := testClient.Field.GetList()
if fields == nil {
t.Error("Expected priority list. Priority list is nil")
t.Error("Expected field list. Field list is nil")
}
if err != nil {
t.Errorf("Error given: %s", err)
Expand Down

0 comments on commit 52e8877

Please sign in to comment.