Browse Source

faces: Fix summary lines of two docstrings

* lisp/org-faces.el (org-document-info):
(org-document-info-keyword): Rework the docstrings to follow the Elisp
convention of using a standalone summary line.
Kyle Meyer 4 years ago
parent
commit
04c35ce791
1 changed files with 6 additions and 5 deletions
  1. 6 5
      lisp/org-faces.el

+ 6 - 5
lisp/org-faces.el

@@ -414,14 +414,15 @@ changes."
   '((((class color) (background light)) (:foreground "midnight blue"))
     (((class color) (background dark)) (:foreground "pale turquoise"))
     (t nil))
-  "Face for document subtitle, date, author and email; i.e. that
-which follows a #+SUBTITLE:, #+DATE:, #+AUTHOR: or #+EMAIL:
-keyword."
+  "Face for document information such as the author and date.
+This applies to the text that follows a #+SUBTITLE:, #+DATE:,
+#+AUTHOR: or #+EMAIL: keyword."
   :group 'org-faces)
 
 (defface org-document-info-keyword '((t :inherit shadow))
-  "Face for #+TITLE:, #+SUBTITLE:, #+AUTHOR:, #+EMAIL: and
-#+DATE: keywords."
+  "Face for document information keywords.
+This face applies to the #+TITLE:, #+SUBTITLE:, #+AUTHOR:,
+#+EMAIL: and #+DATE: keywords."
   :group 'org-faces)
 
 (defface org-block `((t :inherit shadow