From mboxrd@z Thu Jan  1 00:00:00 1970
From: Giovanni Ridolfi <giovanni.ridolfi@yahoo.it>
Subject: Re: [PATCH] include explanations of how to look up a docstring
Date: Thu, 09 Dec 2010 18:38:11 +0100
Message-ID: <83aakevocc.fsf@yahoo.it>
References: <1291842341-15199-1-git-send-email-bjg@network-theory.co.uk>
	<1291842341-15199-2-git-send-email-bjg@network-theory.co.uk>
	<1291842341-15199-3-git-send-email-bjg@network-theory.co.uk>
	<1291842341-15199-4-git-send-email-bjg@network-theory.co.uk>
	<1291842341-15199-5-git-send-email-bjg@network-theory.co.uk>
	<1291842341-15199-6-git-send-email-bjg@network-theory.co.uk>
	<1291842341-15199-7-git-send-email-bjg@network-theory.co.uk>
	<1291842341-15199-8-git-send-email-bjg@network-theory.co.uk>
Mime-Version: 1.0
Content-Type: text/plain; charset=us-ascii
Return-path: <emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org>
Received: from [140.186.70.92] (port=51165 helo=eggs.gnu.org)
	by lists.gnu.org with esmtp (Exim 4.43) id 1PQneI-0002mz-Ke
	for emacs-orgmode@gnu.org; Thu, 09 Dec 2010 16:03:49 -0500
Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71)
	(envelope-from <giovanni.ridolfi@yahoo.it>) id 1PQkQx-000378-7Y
	for emacs-orgmode@gnu.org; Thu, 09 Dec 2010 12:37:36 -0500
Received: from nm17-vm0.bullet.mail.ukl.yahoo.com ([217.146.183.93]:37989)
	by eggs.gnu.org with smtp (Exim 4.71)
	(envelope-from <giovanni.ridolfi@yahoo.it>) id 1PQkQw-00036e-Td
	for emacs-orgmode@gnu.org; Thu, 09 Dec 2010 12:37:35 -0500
In-Reply-To: <1291842341-15199-8-git-send-email-bjg@network-theory.co.uk>
	(Brian Gough's message of "Wed, 8 Dec 2010 21:05:30 +0000")
List-Id: "General discussions about Org-mode." <emacs-orgmode.gnu.org>
List-Unsubscribe: <http://lists.gnu.org/mailman/listinfo/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: <http://lists.gnu.org/mailman/listinfo/emacs-orgmode>,
	<mailto:emacs-orgmode-request@gnu.org?subject=subscribe>
Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org
To: Brian Gough <bjg@network-theory.co.uk>
Cc: emacs-orgmode@gnu.org, carsten.dominik@gmail.com

Brian Gough <bjg@network-theory.co.uk> writes:

> include explanations of how to look up a docstring

> --- a/doc/org.texi
> +++ b/doc/org.texi
> @@ -1346,8 +1346,7 @@ Clone a subtree by making a number of sibling copies of it.  You will be
[...]
> This can be useful, for example,
>  to create a number of tasks related to a series of lectures to prepare.  For
> -more details, see the docstring of the command
> -@code{org-clone-subtree-with-time-shift}.
> +more details, see the docstring@footnote{Docstrings for commands can
> be displayed with @kbd{M-x describe-function} or @kbd{C-h f}.} 

[...]

>  This is handled by the variable @code{org-footnote-auto-label} and its
> -corresponding @code{#+STARTUP} keywords.  See the docstring of that variable
> -for details.
> +corresponding @code{#+STARTUP} keywords. See the
> docstring@footnote{Docstrings for variables can be displayed with
> @kbd{M-x describe-variable} or @kbd{C-h v}.} of that variable for
> details.

IMO these explanations are redundant. 

It is an Org-mode manual not a GNU/Emacs manual.

see eg:
http://lists.gnu.org/archive/html/emacs-orgmode/2006-11/msg00012.html

;-)

cheers,
Giovanni