aboutsummaryrefslogtreecommitdiffstats
path: root/doc/lispref
diff options
context:
space:
mode:
authorGlenn Morris2014-03-22 15:36:29 -0700
committerGlenn Morris2014-03-22 15:36:29 -0700
commitf9c81e7b487ec0c7e9ff1dbd5f1959cba4433f4c (patch)
treed495c678a854371767390e62d40e3f178435c0f0 /doc/lispref
parent5076d275135c9cbcf1f57182b6294e83b6fd4785 (diff)
downloademacs-f9c81e7b487ec0c7e9ff1dbd5f1959cba4433f4c.tar.gz
emacs-f9c81e7b487ec0c7e9ff1dbd5f1959cba4433f4c.zip
Include interactive-only information in describe-function output
* lisp/help-fns.el (help-fns--interactive-only): New function. (help-fns-describe-function-functions): Add the above function. * lisp/simple.el (beginning-of-buffer, end-of-buffer, insert-buffer) (next-line, previous-line): Remove hand-written interactive-only information from doc strings, it is auto-generated now. * lisp/bookmark.el (bookmark-write): * lisp/epa-mail.el (epa-mail-decrypt, epa-mail-verify, epa-mail-sign) (epa-mail-import-keys): Mark interactive-only, and remove hand-written interactive-only information from doc strings. * lisp/epa.el (epa-decrypt-armor-in-region, epa-verify-region) (epa-verify-cleartext-in-region, epa-sign-region, epa-encrypt-region): * lisp/files.el (not-modified): * lisp/simple.el (mark-whole-buffer): Mark interactive-only. * doc/lispref/commands.texi (Defining Commands): Mention that interactive-only also affects describe-function. * etc/NEWS: Mention this.
Diffstat (limited to 'doc/lispref')
-rw-r--r--doc/lispref/ChangeLog3
-rw-r--r--doc/lispref/commands.texi13
2 files changed, 10 insertions, 6 deletions
diff --git a/doc/lispref/ChangeLog b/doc/lispref/ChangeLog
index becce3eea60..870d2dd5d37 100644
--- a/doc/lispref/ChangeLog
+++ b/doc/lispref/ChangeLog
@@ -1,5 +1,8 @@
12014-03-22 Glenn Morris <rgm@gnu.org> 12014-03-22 Glenn Morris <rgm@gnu.org>
2 2
3 * commands.texi (Defining Commands):
4 Mention that interactive-only also affects describe-function.
5
3 * functions.texi (Declare Form): Add interactive-only. 6 * functions.texi (Declare Form): Add interactive-only.
4 * commands.texi (Defining Commands) Mention declare. 7 * commands.texi (Defining Commands) Mention declare.
5 8
diff --git a/doc/lispref/commands.texi b/doc/lispref/commands.texi
index 2b1423101a7..721a485382e 100644
--- a/doc/lispref/commands.texi
+++ b/doc/lispref/commands.texi
@@ -128,12 +128,13 @@ form in the function body itself. This feature is seldom used.
128never directly from Lisp. In that case, give the function a 128never directly from Lisp. In that case, give the function a
129non-@code{nil} @code{interactive-only} property, either directly 129non-@code{nil} @code{interactive-only} property, either directly
130or via @code{declare} (@pxref{Declare Form}). This causes the 130or via @code{declare} (@pxref{Declare Form}). This causes the
131byte compiler to warn if the command is called from Lisp. The value 131byte compiler to warn if the command is called from Lisp. The output
132of the property can be: a string, which the byte-compiler will 132of @code{describe-function} will include similar information.
133use directly in its warning (it should end with a period, 133The value of the property can be: a string, which the byte-compiler
134and not start with a capital, e.g. ``use @dots{} instead.''); @code{t}; 134will use directly in its warning (it should end with a period, and not
135any other symbol, which should be an alternative function to use in 135start with a capital, e.g. ``use @dots{} instead.''); @code{t}; any
136Lisp code. 136other symbol, which should be an alternative function to use in Lisp
137code.
137 138
138@menu 139@menu
139* Using Interactive:: General rules for @code{interactive}. 140* Using Interactive:: General rules for @code{interactive}.