From mboxrd@z Thu Jan 1 00:00:00 1970 From: Matt Price Subject: Re: "COMMENT" keyword not properly documented in the manual Date: Tue, 10 Jan 2017 15:10:13 -0500 Message-ID: References: <22638.29899.634767.904773@frac.u-strasbg.fr> <87d1fxyusv.fsf@nicolasgoaziou.fr> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary=f403045c12b46f5ddb0545c312cb Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:53015) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cR2kJ-0008GI-Vx for emacs-orgmode@gnu.org; Tue, 10 Jan 2017 15:10:18 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cR2kI-0004bR-MS for emacs-orgmode@gnu.org; Tue, 10 Jan 2017 15:10:15 -0500 Received: from mail-it0-x22a.google.com ([2607:f8b0:4001:c0b::22a]:37608) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1cR2kI-0004b4-Gi for emacs-orgmode@gnu.org; Tue, 10 Jan 2017 15:10:14 -0500 Received: by mail-it0-x22a.google.com with SMTP id r185so56975010ita.0 for ; Tue, 10 Jan 2017 12:10:14 -0800 (PST) In-Reply-To: <87d1fxyusv.fsf@nicolasgoaziou.fr> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: "Emacs-orgmode" To: Nicolas Goaziou Cc: Org Mode , Alain.Cochard@unistra.fr --f403045c12b46f5ddb0545c312cb Content-Type: text/plain; charset=UTF-8 On Sun, Jan 8, 2017 at 6:51 PM, Nicolas Goaziou wrote: > Hello, > > Alain.Cochard@unistra.fr writes: > > > Unaware that "COMMENT" was a specific org string, > > It is special only at the beginning of a headline (but past TODO keyword > and priority cookie, if any). > > > 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'll just say that once I learned about COMMENT -- from the list, not from the manual -- I started using it pretty extensively. Also, the Github org-->html renderer hides COMMENT trees by default. For these reasons, I think the current default is sensible. But yeah, it should be documented. --f403045c12b46f5ddb0545c312cb Content-Type: text/html; charset=UTF-8 Content-Transfer-Encoding: quoted-printable


On Sun, Jan 8, 2017 at 6:51 PM, Nicolas Goaziou <<= a href=3D"mailto:mail@nicolasgoaziou.fr" target=3D"_blank">mail@nicolasgoaz= iou.fr> wrote:
Hello,

Alain.Cochard@unistra.fr wr= ites:

> Unaware that "COMMENT" was a specific org string,

It is special only at the beginning of a headline (but past TODO key= word
and priority cookie, if any).

> I had used it at the beginning of a headline, resulting in biased tag<= br> > and string searches ('C-c a m' or 'C-c a s'). (I was u= nlucky: the
> color of the headline was the same as the COMMENT's, so I did not<= br> > 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 s= aid 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'll just say that once I lea= rned about COMMENT -- from the list, not from the manual -- I started using= it pretty extensively.=C2=A0 Also, the Github org-->html renderer hides= COMMENT trees by default.=C2=A0 For these reasons, I think the current def= ault is sensible.=C2=A0 But yeah, it should be documented.=C2=A0=C2=A0
=

--f403045c12b46f5ddb0545c312cb--