summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBastien Guerry <bzg@altern.org>2012-08-22 02:39:18 +0200
committerBastien Guerry <bzg@altern.org>2012-08-22 02:39:18 +0200
commit655c7fb3607a2f2cc1cd20f6e27b3d368d7971e7 (patch)
tree3b7ef3b95bce169d0117bc7ef29e6b31cc050b4f
parent8e307a8ef261a3cc65a4da1ac717b4e2dcf3b6b4 (diff)
downloadorg-mode-655c7fb3607a2f2cc1cd20f6e27b3d368d7971e7.tar.gz
org.el: Small docstring clean-up
* org.el (org-ds-keyword-length, org-make-tags-matcher): Docstring clean-up.
-rw-r--r--lisp/org.el21
1 files changed, 10 insertions, 11 deletions
diff --git a/lisp/org.el b/lisp/org.el
index 54ef04b..9af3a7f 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -4423,7 +4423,7 @@ TODO state, priority and tags.")
Also put tags into group 4 if tags are present.")
(make-variable-buffer-local 'org-todo-line-tags-regexp)
(defvar org-ds-keyword-length 12
- "Maximum length of the Deadline and SCHEDULED keywords.")
+ "Maximum length of the DEADLINE and SCHEDULED keywords.")
(make-variable-buffer-local 'org-ds-keyword-length)
(defvar org-deadline-regexp nil
"Matches the DEADLINE keyword.")
@@ -13295,19 +13295,18 @@ instead of the agenda files."
(defun org-make-tags-matcher (match)
"Create the TAGS/TODO matcher form for the selection string MATCH.
-The variable `todo-only' is scoped dynamically into this function; it will be
-set to t if the matcher restricts matching to TODO entries,
+The variable `todo-only' is scoped dynamically into this function.
+It will be set to t if the matcher restricts matching to TODO entries,
otherwise will not be touched.
Returns a cons of the selection string MATCH and the constructed
-lisp form implementing the matcher. The matcher is to be
-evaluated at an Org entry, with point on the headline,
-and returns t if the entry matches the
-selection string MATCH. The returned lisp form references
-two variables with information about the entry, which must be
-bound around the form's evaluation: todo, the TODO keyword at the
-entry (or nil of none); and tags-list, the list of all tags at the
-entry including inherited ones. Additionally, the category
+lisp form implementing the matcher. The matcher is to be evaluated
+at an Org entry, with point on the headline, and returns t if the
+entry matches the selection string MATCH. The returned lisp form
+references two variables with information about the entry, which
+must be bound around the form's evaluation: todo, the TODO keyword
+at the entry (or nil of none); and tags-list, the list of all tags
+at the entry including inherited ones. Additionally, the category
of the entry (if any) must be specified as the text property
'org-category on the headline.