Stuck projects: Improve docstring of org-stuck-projects

2 files changed, 6 insertions, 2 deletions

diff --git a/lisp/ChangeLog b/lisp/ChangeLog
index bca70f4..d6fba32 100755
--- a/lisp/ChangeLog
+++ b/lisp/ChangeLog
@@ -4,6 +4,7 @@
 	(org-agenda-get-progress, org-agenda-get-deadlines)
 	(org-agenda-get-scheduled, org-agenda-get-blocks): Optimizations,
 	in particular, wait as long as possible to collect the tags.
+	(org-stuck-projects): Improve docstring.
 
 	* org.el (org-store-link): No errors when getting custom id before
 	first headline.
diff --git a/lisp/org-agenda.el b/lisp/org-agenda.el
index 6e4dbce..0b2370c 100644
--- a/lisp/org-agenda.el
+++ b/lisp/org-agenda.el
@@ -424,7 +424,10 @@ This is a list of four items:
 3. A list of tags identifying non-stuck projects.
    If the project subtree contains any headline with one of these tags,
    the project is considered to be not stuck.  If you specify \"*\" as
-   a tag, any tag will mark the project unstuck.
+   a tag, any tag will mark the project unstuck.  Note that this is about
+   the explicit presence of a tag somewhere in the subtree, inherited
+   tags to not count here.  If inherited tags make a project not stuck,
+   use \"-TAG\" in the tags part of the matcher under (1.) above.
 4. An arbitrary regular expression matching non-stuck projects.
 
 If the project turns out to be not stuck, search continues also in the
@@ -440,7 +443,7 @@ or `C-c a #' to produce the list."
 	  (string :tag "Tags/TODO match to identify a project")
 	  (repeat :tag "Projects are *not* stuck if they have an entry with TODO keyword any of" (string))
 	  (repeat :tag "Projects are *not* stuck if they have an entry with TAG being any of" (string))
-	  (regexp :tag "Projects are *not* stuck if this regexp matches\ninside the subtree")))
+	  (regexp :tag "Projects are *not* stuck if this regexp matches inside the subtree")))
 
 (defcustom org-agenda-filter-effort-default-operator "<"
   "The default operator for effort estimate filtering.