mirror/org-mode
1
0
Fork 0
mirror of https://git.savannah.gnu.org/git/emacs/org-mode.git synced 2024-10-18 02:19:46 +00:00
Code

lisp/ox.el (org-export-options-alist): Improve docstring

Browse Source 
Users often confuse alist key and the first element of the alist value
- KEYWORD in this alist.  Make the distinction more clear in the
docstring.

Link: https://list.orgmode.org/orgmode/87h6biyrd7.fsf@localhost/
This commit is contained in:
Ihor Radchenko 2024-08-22 14:53:49 +02:00
parent 8fd6cc9020
commit 34979457f9
No known key found for this signature in database
GPG Key ID: 6470762A7DA11D8B
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
lisp/ox.el
View File

@ -156,8 +156,11 @@
(:cite-export "CITE_EXPORT" nil org-cite-export-processors))
"Alist between export properties and ways to set them.
The key of the alist is the property name, and the value is a list
like (KEYWORD OPTION DEFAULT BEHAVIOR) where:
Each element of the alist is a list like
(ALIST-KEY KEYWORD OPTION DEFAULT BEHAVIOR)
ALIST-KEY is the key of the alist - a symbol like `:option', and the
value is (KEYWORD OPTION ...).
KEYWORD is a string representing a buffer keyword, or nil. Each
property defined this way can also be set, during subtree