Skip to content

Commit 9ed216f

Browse files
committed
Doc changes
1 parent e24177d commit 9ed216f

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

org-jira.el

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -333,11 +333,11 @@ See `org-default-priority' for more info."
333333
"An alist of plists containing custom fields to add to issues.
334334
335335
A sample value might be
336-
((customfield_10033 . (:type string :location 'headline))
337-
(customfield_10108 . (:type number :location 'property :name \"Priority\"))).
336+
'((customfield_10033 . (:type string :location 'headline))
337+
(customfield_10108 . (:type number :location 'property :name \"Priority\"))).
338338
339339
List of properties for each plist:
340-
:type - Required. Type of the field. Defaults are 'string, 'boolean or
340+
:type - Type of the field (required). Built-in types are 'string, 'boolean or
341341
'number. You can define custom types inside
342342
`org-jira-custom-field-encoders'.
343343
:location - A symbol, either 'property to format the field as an Org
@@ -354,7 +354,7 @@ List of properties for each plist:
354354
"An alist of plists containing custom field type handlers.
355355
356356
A sample value might be
357-
((multicheckboxes . (:encode #'my-encoder :decode #'my-decoder)))
357+
'((multicheckboxes . (:encode #'my-encoder :decode #'my-decoder)))
358358
359359
Encoding functions take a JSON value and return a string.
360360
Decoding functions take a string and return a JSON value."
@@ -366,6 +366,9 @@ Decoding functions take a string and return a JSON value."
366366
The car of each element is the org-jira field name.
367367
The cdr of each element is the Jira issue field ID as returned by the API.
368368
369+
This is useful if your organization uses a custom field for the
370+
issue description or other \"built-in\" field instead of the default.
371+
369372
A sample value might be
370373
'((description . customfield_10000)
371374
(summary . customfield_10001)
@@ -389,7 +392,6 @@ Valid org-jira fields you can use:
389392
- status
390393
- summary
391394
- issuetype
392-
- issuetype
393395
- updated"
394396
:group 'org-jira
395397
:type '(alist :key-type symbol :value-type symbol))

0 commit comments

Comments
 (0)