From mboxrd@z Thu Jan 1 00:00:00 1970 From: Dave Abrahams Subject: Re: Why functions like org-show-subtree are undocumented? Date: Sun, 26 Feb 2012 10:25:28 -0500 Message-ID: References: Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([208.118.235.92]:36926) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1S1g5N-0005SY-Ht for emacs-orgmode@gnu.org; Sun, 26 Feb 2012 10:32:30 -0500 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1S1g5M-0004Le-9p for emacs-orgmode@gnu.org; Sun, 26 Feb 2012 10:32:29 -0500 Received: from plane.gmane.org ([80.91.229.3]:55014) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1S1g5M-0004La-3t for emacs-orgmode@gnu.org; Sun, 26 Feb 2012 10:32:28 -0500 Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1S1g5H-0001qA-2C for emacs-orgmode@gnu.org; Sun, 26 Feb 2012 16:32:23 +0100 Received: from 207-172-223-249.c3-0.smr-ubr3.sbo-smr.ma.static.cable.rcn.com ([207.172.223.249]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 26 Feb 2012 16:32:23 +0100 Received: from dave by 207-172-223-249.c3-0.smr-ubr3.sbo-smr.ma.static.cable.rcn.com with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Sun, 26 Feb 2012 16:32:23 +0100 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-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: emacs-orgmode@gnu.org on Tue Jan 24 2012, Carsten Dominik 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