[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] emacs-25 278d8c8: Document 'describe-symbol'
From: |
Eli Zaretskii |
Subject: |
[Emacs-diffs] emacs-25 278d8c8: Document 'describe-symbol' |
Date: |
Sat, 14 Nov 2015 20:03:53 +0000 |
branch: emacs-25
commit 278d8c8e6c92729e4a00ae61699bc8f95342ea81
Author: Eli Zaretskii <address@hidden>
Commit: Eli Zaretskii <address@hidden>
Document 'describe-symbol'
* doc/emacs/help.texi (Help Summary): Mention "C-h o".
(Name Help): Document "C-h o" and describe-symbol.
* lisp/help-fns.el (describe-symbol): Doc fix.
---
doc/emacs/help.texi | 12 ++++++++++++
etc/NEWS | 5 ++++-
lisp/help-fns.el | 5 ++++-
3 files changed, 20 insertions(+), 2 deletions(-)
diff --git a/doc/emacs/help.texi b/doc/emacs/help.texi
index a9c63b9..8b4adf9 100644
--- a/doc/emacs/help.texi
+++ b/doc/emacs/help.texi
@@ -126,6 +126,10 @@ Display documentation of the current major mode and minor
modes
(@code{describe-mode}).
@item C-h n
Display news of recent Emacs changes (@code{view-emacs-news}).
address@hidden C-h o @var{symbol}
+Display documentation of the Lisp symbol named @var{symbol}
+(@code{describe-symbol}). This will show the documentation of all
+kinds of symbols: functions, variables, and faces.
@item C-h p
Find packages by topic keyword (@code{finder-by-keyword}). This lists
packages using a package menu buffer. @xref{Packages}.
@@ -272,6 +276,14 @@ source files installed (@pxref{Hyperlinking}).
(@code{Info-goto-emacs-command-node}). This knows about various
manuals, not just the Emacs manual, and finds the right one.
address@hidden C-h o
address@hidden describe-symbol
+ @kbd{C-h o} (@code{describe-symbol}) is like @kbd{C-h f} and
address@hidden v}, but it describes any symbol, be it a function, a
+variable, or a face. If the symbol has more than one definition, like
+it has both definition as a function and as a variable, this command
+will show the documentation of all of them, one after the other.
+
@node Apropos
@section Apropos
@cindex apropos
diff --git a/etc/NEWS b/etc/NEWS
index 6608b79..9793d5e 100644
--- a/etc/NEWS
+++ b/etc/NEWS
@@ -121,13 +121,16 @@ the variable `dir-locals-file' for more information.
information about mode local overrides (defined by cedet/mode-local.el
`define-overloadable-function' `define-mode-local-overrides').
++++
** New `display-buffer' action function `display-buffer-use-some-frame'.
This displays the buffer in an existing frame other than the current
frame, and allows the caller to specify a frame predicate to exclude
frames.
++++
** New documentation command `describe-symbol'.
-Works for functions, variables, faces, etc.
+Works for functions, variables, faces, etc. It is bound to `C-h o' by
+default.
** New user option `search-default-regexp-mode'
specifies the default mode for I-search.
diff --git a/lisp/help-fns.el b/lisp/help-fns.el
index e810a26..41911b8 100644
--- a/lisp/help-fns.el
+++ b/lisp/help-fns.el
@@ -997,7 +997,10 @@ file-local variable.\n")
;;;###autoload
(defun describe-symbol (symbol &optional buffer frame)
"Display the full documentation of SYMBOL.
-Will show the info of SYMBOL as a function, variable, and/or face."
+Will show the info of SYMBOL as a function, variable, and/or face.
+Optional arguments BUFFER and FRAME specify for which buffer and
+frame to show the information about SYMBOL; they default to the
+current buffer and the selected frame, respectively."
(interactive
(let* ((v-or-f (symbol-at-point))
(found (cl-some (lambda (x) (funcall (nth 1 x) v-or-f))
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] emacs-25 278d8c8: Document 'describe-symbol',
Eli Zaretskii <=