emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Stuck projects documentation suggestion
@ 2016-11-13 20:29 Jon Kristensen
  2016-11-14 11:32 ` Nicolas Goaziou
  0 siblings, 1 reply; 3+ messages in thread
From: Jon Kristensen @ 2016-11-13 20:29 UTC (permalink / raw)
  To: emacs-orgmode

Hi!

Looking at http://orgmode.org/manual/Stuck-projects.html>, it wasn't 
clear to me that "+PROJECT/-MAYBE-DONE" was something called a "match 
syntax". If the documentation could be extended to include this 
information, and a link to the matching tags and properties page, it 
would be more understandable for new users. (Of course, it would also 
make the page more verbose, but I think the length of this page is short 
enough that it could probably be an acceptable trade-off.)

The docstring for "org-stuck-projects" does include a reference to the 
match syntax. (However, "C-h v" (describe variable) didn't work for 
"org-stuck-projects" for me until I loaded "org-agenda", which was 
surprising from my perspective as a newbie.)

All the best,
Jon

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Stuck projects documentation suggestion
  2016-11-13 20:29 Stuck projects documentation suggestion Jon Kristensen
@ 2016-11-14 11:32 ` Nicolas Goaziou
  2016-12-24 12:26   ` Jon Kristensen
  0 siblings, 1 reply; 3+ messages in thread
From: Nicolas Goaziou @ 2016-11-14 11:32 UTC (permalink / raw)
  To: Jon Kristensen; +Cc: emacs-orgmode

Hello,

Jon Kristensen <info@jonkri.com> writes:

> Looking at http://orgmode.org/manual/Stuck-projects.html>, it wasn't
> clear to me that "+PROJECT/-MAYBE-DONE" was something called a "match
> syntax". If the documentation could be extended to include this
> information, and a link to the matching tags and properties page, it
> would be more understandable for new users.

Isn't it already done in the footnote in the page above?

Would you want to suggest a better wording for this page?

> The docstring for "org-stuck-projects" does include a reference to the
> match syntax. (However, "C-h v" (describe variable) didn't work for
> "org-stuck-projects" for me until I loaded "org-agenda", which was
> surprising from my perspective as a newbie.)

It should probably be renamed to `org-agenda-stuck-projects' then.

Regards,

-- 
Nicolas Goaziou

^ permalink raw reply	[flat|nested] 3+ messages in thread

* Re: Stuck projects documentation suggestion
  2016-11-14 11:32 ` Nicolas Goaziou
@ 2016-12-24 12:26   ` Jon Kristensen
  0 siblings, 0 replies; 3+ messages in thread
From: Jon Kristensen @ 2016-12-24 12:26 UTC (permalink / raw)
  To: emacs-orgmode

On 11/14/2016 12:32 PM, Nicolas Goaziou wrote:
> Hello,
>
> Jon Kristensen <info@jonkri.com> writes:
>
>> Looking at http://orgmode.org/manual/Stuck-projects.html>, it wasn't
>> clear to me that "+PROJECT/-MAYBE-DONE" was something called a "match
>> syntax". If the documentation could be extended to include this
>> information, and a link to the matching tags and properties page, it
>> would be more understandable for new users.
> Isn't it already done in the footnote in the page above?
>
> Would you want to suggest a better wording for this page?

Sorry for the late reply!

I think it looks alright now. :)

>> The docstring for "org-stuck-projects" does include a reference to the
>> match syntax. (However, "C-h v" (describe variable) didn't work for
>> "org-stuck-projects" for me until I loaded "org-agenda", which was
>> surprising from my perspective as a newbie.)
> It should probably be renamed to `org-agenda-stuck-projects' then.
>
> Regards,
>

^ permalink raw reply	[flat|nested] 3+ messages in thread

end of thread, other threads:[~2016-12-24 12:27 UTC | newest]

Thread overview: 3+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2016-11-13 20:29 Stuck projects documentation suggestion Jon Kristensen
2016-11-14 11:32 ` Nicolas Goaziou
2016-12-24 12:26   ` Jon Kristensen

Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).