Skip to content

Commit

Permalink
Doc changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Ruin0x11 committed Jan 21, 2024
1 parent e24177d commit 1606373
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 6 deletions.
2 changes: 1 addition & 1 deletion jiralib.el
Original file line number Diff line number Diff line change
Expand Up @@ -1043,7 +1043,7 @@ CALLBACK will be invoked if passed in upon endpoint completion."
(jiralib-call "updateWorklog" callback issue-id worklog-id worklog)))

(defvar jiralib-issue-fields-cache nil
"Mapping of jiralib issue field keys to symbols.")
"Mapping of jiralib issue field IDs to names.")

(defun jiralib-get-issue-fields ()
"Return an assoc list mapping an issue field id to its details.
Expand Down
12 changes: 7 additions & 5 deletions org-jira.el
Original file line number Diff line number Diff line change
Expand Up @@ -333,11 +333,11 @@ See `org-default-priority' for more info."
"An alist of plists containing custom fields to add to issues.
A sample value might be
((customfield_10033 . (:type string :location 'headline))
(customfield_10108 . (:type number :location 'property :name \"Priority\"))).
'((customfield_10033 . (:type string :location 'headline))
(customfield_10108 . (:type number :location 'property :name \"Priority\"))).
List of properties for each plist:
:type - Required. Type of the field. Defaults are 'string, 'boolean or
:type - Type of the field (required). Built-in types are 'string, 'boolean or
'number. You can define custom types inside
`org-jira-custom-field-encoders'.
:location - A symbol, either 'property to format the field as an Org
Expand All @@ -354,7 +354,7 @@ List of properties for each plist:
"An alist of plists containing custom field type handlers.
A sample value might be
((multicheckboxes . (:encode #'my-encoder :decode #'my-decoder)))
'((multicheckboxes . (:encode #'my-encoder :decode #'my-decoder)))
Encoding functions take a JSON value and return a string.
Decoding functions take a string and return a JSON value."
Expand All @@ -366,6 +366,9 @@ Decoding functions take a string and return a JSON value."
The car of each element is the org-jira field name.
The cdr of each element is the Jira issue field ID as returned by the API.
This is useful if your organization uses a custom field for the
issue description or other \"built-in\" field instead of the default.
A sample value might be
'((description . customfield_10000)
(summary . customfield_10001)
Expand All @@ -389,7 +392,6 @@ Valid org-jira fields you can use:
- status
- summary
- issuetype
- issuetype
- updated"
:group 'org-jira
:type '(alist :key-type symbol :value-type symbol))
Expand Down

0 comments on commit 1606373

Please sign in to comment.