From: Giovanni Ridolfi <giovanni.ridolfi@yahoo.it>
To: Brian Gough <bjg@network-theory.co.uk>
Cc: emacs-orgmode@gnu.org, carsten.dominik@gmail.com
Subject: Re: [PATCH] include explanations of how to look up a docstring
Date: Thu, 09 Dec 2010 18:38:11 +0100 [thread overview]
Message-ID: <83aakevocc.fsf@yahoo.it> (raw)
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")
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
next prev parent reply other threads:[~2010-12-09 21:03 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2010-12-08 21:05 [PATCH] use @result{} instead of --> (looks nicer) Brian Gough
2010-12-08 21:05 ` [PATCH] use macro for @LaTeX name Brian Gough
2010-12-08 21:05 ` [PATCH] make use of the provided @ie and @eg macros to fix the spacing Brian Gough
2010-12-08 21:05 ` [PATCH] fix commas that should be full stops, semicolons or emdashes Brian Gough
2010-12-08 21:05 ` [PATCH] fix plain text that looks better with markup Brian Gough
2010-12-08 21:05 ` [PATCH] use kbd font Brian Gough
2010-12-08 21:05 ` [PATCH] improvements to wording style Brian Gough
2010-12-08 21:05 ` [PATCH] include explanations of how to look up a docstring Brian Gough
2010-12-08 21:05 ` [PATCH] use a full sentence Brian Gough
2010-12-08 21:05 ` [PATCH] tangling is not a widely-known term, describe it as literate programming Brian Gough
2010-12-08 21:05 ` [PATCH] make "time stamps" consistent with timestamps Brian Gough
2010-12-08 21:05 ` [PATCH] make explanation of keyword lines clearer Brian Gough
2010-12-08 21:05 ` [PATCH] use emdashes when needed Brian Gough
2010-12-08 21:05 ` [PATCH] put emacs functions in code font Brian Gough
2010-12-08 21:05 ` [PATCH] use code font for example footnote labels Brian Gough
2010-12-08 21:05 ` [PATCH] fix missing word in math formatting section Brian Gough
2010-12-08 21:05 ` [PATCH] typo/grammar fix for .done CSS explanation Brian Gough
2010-12-08 21:05 ` [PATCH] explain how to check the default version of Org Brian Gough
2010-12-08 21:05 ` [PATCH] add index entries Brian Gough
2011-02-01 11:37 ` [Accepted] " Bastien Guerry
2011-02-01 11:36 ` [Accepted] explain how to check the default version of Org Bastien Guerry
2011-02-01 11:34 ` [Accepted] typo/grammar fix for .done CSS explanation Bastien Guerry
2011-02-01 11:33 ` [Accepted] use code font for example footnote labels Bastien Guerry
2011-02-01 11:32 ` [Accepted] put emacs functions in code font Bastien Guerry
2011-02-01 11:29 ` [Accepted] make "time stamps" consistent with timestamps Bastien Guerry
2010-12-09 17:38 ` Giovanni Ridolfi [this message]
2011-01-26 17:33 ` [Accepted] use @result{} instead of --> (looks nicer) Bastien Guerry
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=83aakevocc.fsf@yahoo.it \
--to=giovanni.ridolfi@yahoo.it \
--cc=bjg@network-theory.co.uk \
--cc=carsten.dominik@gmail.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).