emacs-orgmode
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [O] Confused about the explanation for 'org-cycle'


From: Kyle Meyer
Subject: Re: [O] Confused about the explanation for 'org-cycle'
Date: Thu, 28 Sep 2017 12:10:45 -0400

Robert Horn <address@hidden> 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



reply via email to

[Prev in Thread] Current Thread [Next in Thread]