summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCarsten Dominik <carsten.dominik@gmail.com>2019-09-06 15:49:04 +0200
committerCarsten Dominik <carsten.dominik@gmail.com>2019-09-06 15:49:04 +0200
commitc47a7394a095e0f683ccc831ce8c6498caef7888 (patch)
tree340d3fdd2a84c9c1f4152f29a4a9dbea2abc0803
parentc580a290acb0525f172c9c5d1c4d0e5b18e59baf (diff)
downloadorg-mode-c47a7394a095e0f683ccc831ce8c6498caef7888.tar.gz
Improve documentation string of `org-agenda-filter-by-regexp'
* lisp/org-agenda.el (org-agenda-filter-by-regexp): Improve docstring.
-rw-r--r--lisp/org-agenda.el10
1 files changed, 6 insertions, 4 deletions
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 2aa3345..5532170 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -7512,11 +7512,13 @@ The top headline is that of the current line."
(defvar org-agenda-regexp-filter nil)
(defun org-agenda-filter-by-regexp (strip)
- "Filter agenda entries by regular expressions.
+ "Filter agenda entries by a regular expressions.
+You will be prompted for the regular expresssion, and the agenda
+view will only show entires that are matched by that expression.
-With one prefix argument, filter out entries matching the regexp.
-If there is already a regexp filter, remove it unless called with
-two prefix arguments."
+With one `\\[universal-argument]' prefix argument, filter out entries matching the regexp.
+With two `\\[universal-argument]' prefix arguments, add the new condition to an already existing
+regexp filter."
(interactive "P")
(cond
((and org-agenda-regexp-filter (not (equal strip '(16))))