From mboxrd@z Thu Jan 1 00:00:00 1970 From: Alain.Cochard@unistra.fr Subject: Re: "COMMENT" keyword not properly documented in the manual Date: Tue, 10 Jan 2017 08:36:36 +0100 Message-ID: <22644.36612.316302.470247@frac.u-strasbg.fr> References: <22638.29899.634767.904773@frac.u-strasbg.fr> <87d1fxyusv.fsf@nicolasgoaziou.fr> Reply-To: alain.cochard@unistra.fr Mime-Version: 1.0 Content-Type: text/plain; charset=iso-8859-1 Content-Transfer-Encoding: quoted-printable Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:37784) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cQqzA-0005AG-NH for emacs-orgmode@gnu.org; Tue, 10 Jan 2017 02:36:49 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1cQqz7-0001Tb-Hh for emacs-orgmode@gnu.org; Tue, 10 Jan 2017 02:36:48 -0500 Received: from mailhost.u-strasbg.fr ([130.79.222.215]:38637) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1cQqz7-0001TJ-BQ for emacs-orgmode@gnu.org; Tue, 10 Jan 2017 02:36:45 -0500 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: emacs-orgmode@gnu.org, Alain.Cochard@unistra.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. >=20 > WDYT=3F 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=3F Seems to me it could help beginners to learn Org; sure, there is 'C-h v org-', but it's not exactly the same for me.) a. --=20 EOST (=C9cole et Observatoire des Sciences de la Terre)=20 IPG (Institut de Physique du Globe) | alain.cochard@unistra.fr 5 rue Ren=E9 Descartes [bureau 106] | Phone: +33 (0)3 68 85 50 44=20 F-67084 Strasbourg Cedex, France | Fax: +33 (0)3 68 85 01 25 =20=