Browse Source

org-element: Update docstring

* org-element.el (org-element-keyword-parser): Mention that `keyword'
is normalized by being upcased.
Leo Vivier 4 years ago
parent
commit
325922c606
1 changed files with 3 additions and 3 deletions
  1. 3 3
      lisp/org-element.el

+ 3 - 3
lisp/org-element.el

@@ -2174,9 +2174,9 @@ the buffer position at the beginning of the first affiliated
 keyword and CDR is a plist of affiliated keywords along with
 their value.
 
-Return a list whose CAR is `keyword' and CDR is a plist
-containing `:key', `:value', `:begin', `:end', `:post-blank' and
-`:post-affiliated' keywords."
+Return a list whose CAR is a normalized `keyword' (uppercase) and
+CDR is a plist containing `:key', `:value', `:begin', `:end',
+`:post-blank' and `:post-affiliated' keywords."
   (save-excursion
     ;; An orphaned affiliated keyword is considered as a regular
     ;; keyword.  In this case AFFILIATED is nil, so we take care of