[Orgmode] [PATCH] include explanations of how to look up a docstring

2010-12-09 Thread Brian Gough
---
 doc/org.texi |6 ++
 1 files changed, 2 insertions(+), 4 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index b9ff083..faa552e 100644
--- 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
 prompted for the number of copies to make, and you can also specify if any
 timestamps in the entry should be shifted.  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 docstr...@footnote{docstrings for commands can be 
displayed with @kbd{M-x describe-function} or @kbd{C-h f}.} of the command 
@code{org-clone-subtree-with-time-shift}.
 @orgcmd{C-c C-w,org-refile}
 Refile entry or region to a different location.  @xref{Refiling notes}.
 @orgcmd{C-c ^,org-sort-entries-or-items}
@@ -1760,8 +1759,7 @@ Since Org allows multiple references to the same note, 
you can then use
 @vindex org-footnote-auto-label
 Footnote labels can be created automatically, or you can create names yourself.
 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 docstr...@footnote{docstrings 
for variables can be displayed with @kbd{M-x describe-variable} or @kbd{C-h 
v}.} of that variable for details.
 
 @noindent The following command handles footnotes:
 
-- 
1.6.0.6


___
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode


Re: [Orgmode] [PATCH] include explanations of how to look up a docstring

2010-12-09 Thread Giovanni Ridolfi
Brian Gough b...@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 docstr...@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
 docstr...@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

___
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode