From: Dave Abrahams <dave@boostpro.com>
To: emacs-orgmode@gnu.org
Subject: Re: Why functions like org-show-subtree are undocumented?
Date: Sun, 26 Feb 2012 10:25:28 -0500 [thread overview]
Message-ID: <m2zkc562hj.fsf@boostpro.com> (raw)
In-Reply-To: C029C73A-9776-4DDC-9022-3870BB3170F4@gmail.com
on Tue Jan 24 2012, Carsten Dominik <carsten.dominik-AT-gmail.com> wrote:
> On 23.1.2012, at 16:27, Alexander Corvinus wrote:
>
>> Hi all,
>>
>> I just reviewed code in org.el and noticed that function
>> org-show-subtree, which is called by org-cycle, unconditionally
>> shows whole subtree (exactly what I wanted to have in my
>> shortcuts!).
>>
>> So the question is - why such useful functions like
>> org-show-subtree, hide-subtree, show-children aren't documented in
>> manual? Because of that, previously I thought that what I wanted was
>> impossible (without source change).
>
> Emacs outline-mode has a plethora of such specific commands, and
> exposes all of them as user interface. Org prides itself
> to have compressed that entire functionality into the TAB and S-TAB
> commands. You specific example, org-show-subtree is basically
> TAB TAB on a closed tree. SO yes, there are lots such commands,
> but I am no sure it would be good to expose them in the manual.
That's the difference between a user manual (documents TAB TAB) and an
API reference manual. But both are needed, especially since all Emacs
users eventually become programmers at some level.
--
Dave Abrahams
BoostPro Computing
http://www.boostpro.com
prev parent reply other threads:[~2012-02-26 15:32 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2012-01-23 16:27 Why functions like org-show-subtree are undocumented? Alexander Corvinus
2012-01-24 9:40 ` Bastien
2012-01-24 11:22 ` Carsten Dominik
2012-02-26 15:25 ` Dave Abrahams [this message]
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=m2zkc562hj.fsf@boostpro.com \
--to=dave@boostpro.com \
--cc=emacs-orgmode@gnu.org \
/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).