From mboxrd@z Thu Jan  1 00:00:00 1970
From: Kyle Meyer <kyle@kyleam.com>
Subject: Re: Confused about the explanation for 'org-cycle'
Date: Thu, 28 Sep 2017 12:10:45 -0400
Message-ID: <87bmluiz22.fsf@kyleam.com>
References: <22975.53875.671661.416361@frac.u-strasbg.fr>
	<874lrzl1gr.fsf@fastmail.fm> <87lgl963jf.fsf@nicolasgoaziou.fr>
	<22986.5564.583945.909910@frac.u-strasbg.fr>
	<877ewl4u8s.fsf@nicolasgoaziou.fr>
	<22986.19586.309718.302611@frac.u-strasbg.fr>
	<87h8vmopww.fsf@nicolasgoaziou.fr> <m3d16adeoj.fsf@alum.mit.edu>
Mime-Version: 1.0
Content-Type: text/plain
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from eggs.gnu.org ([2001:4830:134:3::10]:45022)
	by lists.gnu.org with esmtp (Exim 4.71)
	(envelope-from <kyle@kyleam.com>) id 1dxbOn-000603-S0
	for emacs-orgmode@gnu.org; Thu, 28 Sep 2017 12:10:59 -0400
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <kyle@kyleam.com>) id 1dxbOi-0000Fk-QY
	for emacs-orgmode@gnu.org; Thu, 28 Sep 2017 12:10:53 -0400
Received: from pb-smtp2.pobox.com ([64.147.108.71]:64314
	helo=sasl.smtp.pobox.com)
	by eggs.gnu.org with esmtps (TLS1.0:DHE_RSA_AES_256_CBC_SHA1:32)
	(Exim 4.71) (envelope-from <kyle@kyleam.com>) id 1dxbOi-0000FS-Ke
	for emacs-orgmode@gnu.org; Thu, 28 Sep 2017 12:10:48 -0400
In-Reply-To: <m3d16adeoj.fsf@alum.mit.edu>
List-Id: "General discussions about Org-mode." <emacs-orgmode.gnu.org>
List-Unsubscribe: <https://lists.gnu.org/mailman/options/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=unsubscribe>
List-Archive: <http://lists.gnu.org/archive/html/emacs-orgmode/>
List-Post: <mailto:emacs-orgmode@gnu.org>
List-Help: <mailto:emacs-orgmode-request@gnu.org?subject=help>
List-Subscribe: <https://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=subscribe>
Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
Sender: "Emacs-orgmode"
	<emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
To: Robert Horn <rjhorn@alum.mit.edu>, Nicolas Goaziou <mail@nicolasgoaziou.fr>
Cc: emacs-orgmode@gnu.org, Alain.Cochard@unistra.fr

Robert Horn <rjhorn@alum.mit.edu> writes:

> Nicolas Goaziou writes:
>
>> Completeness is not possible. For example, we do not document every
>> variable in the manual. Besides, when reading a pile of special rules
>> for special cases, the reader may lose focus and miss the whole concept.
>>
>> BTW, a "docstring" is the documentation you get when using, e.g., `C-h
>> v' or `C-h f'.
>
> Actually, an effective way to deal with this is to have two sections: "All
> external org functions" and "All external org variables" that merely lists them
> all alphabetically, and begins with a short paragraph on what a
> doc-string is and how to get it for these.

I don't think maintaining a list of all Org's user options or commands
is a good idea.  It is better to point users to commands like
apropos-user-option and apropos-command.

-- 
Kyle