Browse Source

Fix predicate comment string

Ref. (info "(elisp) Documentation Tips")

* lisp/org.el (org-at-comment-p, org-at-drawer-p)
(org-at-block-p): Fix documentation.
Gustav Wikström 5 years ago
parent
commit
6175593530
1 changed files with 3 additions and 3 deletions
  1. 3 3
      lisp/org.el

+ 3 - 3
lisp/org.el

@@ -20511,20 +20511,20 @@ unless optional argument NO-INHERITANCE is non-nil."
     (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
     (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
 
 
 (defun org-at-comment-p nil
 (defun org-at-comment-p nil
-  "Is cursor in a commented line?"
+  "Return t if cursor is in a commented line."
   (save-excursion
   (save-excursion
     (save-match-data
     (save-match-data
       (beginning-of-line)
       (beginning-of-line)
       (looking-at "^[ \t]*# "))))
       (looking-at "^[ \t]*# "))))
 
 
 (defun org-at-drawer-p nil
 (defun org-at-drawer-p nil
-  "Is cursor at a drawer keyword?"
+  "Return t if cursor is at a drawer keyword."
   (save-excursion
   (save-excursion
     (move-beginning-of-line 1)
     (move-beginning-of-line 1)
     (looking-at org-drawer-regexp)))
     (looking-at org-drawer-regexp)))
 
 
 (defun org-at-block-p nil
 (defun org-at-block-p nil
-  "Is cursor at a block keyword?"
+  "Return t if cursor is at a block keyword."
   (save-excursion
   (save-excursion
     (move-beginning-of-line 1)
     (move-beginning-of-line 1)
     (looking-at org-block-regexp)))
     (looking-at org-block-regexp)))