From: Alain.Cochard@unistra.fr
To: Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: emacs-orgmode@gnu.org, Alain.Cochard@unistra.fr
Subject: Re: "COMMENT" keyword not properly documented in the manual
Date: Tue, 10 Jan 2017 08:36:36 +0100 [thread overview]
Message-ID: <22644.36612.316302.470247@frac.u-strasbg.fr> (raw)
In-Reply-To: <87d1fxyusv.fsf@nicolasgoaziou.fr>
Hi, and thanks for the feedback.
Nicolas Goaziou writes on Mon 9 Jan 2017 00:51:
> > Unaware that "COMMENT" was a specific org string,
[...]
> > I had used it at the beginning of a headline, resulting in biased tag
> > and string searches ('C-c a m' or 'C-c a s'). (I was unlucky: the
> > color of the headline was the same as the COMMENT's, so I did not
> > notice anything strange.) I think I finally understood, and found
> > about the org-agenda-skip-comment-trees variable, but...
[...]
> > So it seems to me that something about "COMMENT" should be said at
> > some place(s) in the "Agenda views" section.
> Considering COMMENT is primarily export related, one option would
> be to make `org-agenda-skip-comment-trees' to nil as a default. In
> this case, it might not even be necessary to document this variable
> in the manual.
>
> WDYT?
I was initially tempted to suggest that nil would indeed be a better
default for this variable, but in this related post
https://lists.gnu.org/archive/html/emacs-orgmode/2013-05/msg00287.html
Samuel Wales says that
"It defaults to `t' which I think is a good default."
Considering the time that you experts spend on endless discussions
about what the default value of some variable should be, I'd rather
remain agnostic on this one. But unless the use of this variable is
obsolete, I feel it has to be documented -- could be as discreet as
one sentence in a footnote. Otherwise, with a nil default, even
people using the export features would have difficulties to know about
it.
(More generally, what would be the harm of having some appendix with a
list of all customizable variables? Seems to me it could help
beginners to learn Org; sure, there is 'C-h v org-<TAB>', but it's not
exactly the same for me.)
a.
--
EOST (École et Observatoire des Sciences de la Terre)
IPG (Institut de Physique du Globe) | alain.cochard@unistra.fr
5 rue René Descartes [bureau 106] | Phone: +33 (0)3 68 85 50 44
F-67084 Strasbourg Cedex, France | Fax: +33 (0)3 68 85 01 25
next prev parent reply other threads:[~2017-01-10 7:36 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2017-01-05 16:31 "COMMENT" keyword not properly documented in the manual Alain.Cochard
2017-01-08 23:51 ` Nicolas Goaziou
2017-01-10 7:36 ` Alain.Cochard [this message]
2017-01-10 18:05 ` Samuel Wales
2017-01-13 23:28 ` Nicolas Goaziou
2017-01-10 20:10 ` Matt Price
2017-06-06 15:19 ` multiple agenda views -- sticky agendas?, buffer renaming? Alain.Cochard
2017-07-03 5:09 ` Bastien
2017-08-22 13:25 ` Alain.Cochard
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: https://www.orgmode.org/
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=22644.36612.316302.470247@frac.u-strasbg.fr \
--to=alain.cochard@unistra.fr \
--cc=emacs-orgmode@gnu.org \
--cc=mail@nicolasgoaziou.fr \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).