Re: [O] Stuck projects documentation suggestion

[Jon Kristensen]

On 11/14/2016 12:32 PM, Nicolas Goaziou wrote:

Hello,

Jon Kristensen  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,

Re: [O] Stuck projects documentation suggestion

[Nicolas Goaziou]

Hello,

Jon Kristensen  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

[O] Stuck projects documentation suggestion

[Jon Kristensen]

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