[ELPA-diffs] /srv/bzr/emacs/elpa r150: * eldoc-eval.el Add infos in Commentary section.

[thierry volpiatto]

------------------------------------------------------------
revno: 150
committer: thierry volpiatto <address@hidden
branch nick: elpa
timestamp: Sat 2011-10-15 11:02:09 +0200
message:
  * eldoc-eval.el Add infos in Commentary section.
modified:
  packages/eldoc-eval/eldoc-eval.el

=== modified file 'packages/eldoc-eval/eldoc-eval.el'
--- a/packages/eldoc-eval/eldoc-eval.el 2011-10-12 01:43:03 +0000
+++ b/packages/eldoc-eval/eldoc-eval.el 2011-10-15 09:02:09 +0000
@@ -1,4 +1,4 @@
-;;; eldoc-eval.el --- Show eldoc when using M-:
+;;; eldoc-eval.el --- Enable eldoc support when minibuffer is in use.
 
 ;; Copyright (C) 2011 Free Software Foundation, Inc.
 
@@ -20,6 +20,26 @@
 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
+;;
+;; This package enable eldoc support when minibuffer is in use.
+;;
+;; Eldoc info are shown by default in mode-line.
+;; but you can have eldoc info somewhere else by setting
+;; `eldoc-in-minibuffer-show-fn' to an other function (e.g `tooltip-show').
+;;
+;; By default with this package `M-:' will use `pp-eval-expression'
+;; instead of `eval-expression'; You can change that in
+;; `eval-prefered-function'.
+;;
+;; It provide also a convenient macro to enable eldoc support
+;; in your own functions using minibuffer or in your defadvices,
+;; that is `with-eldoc-in-minibuffer'.
+;;
+;; Users of own minibuffer frame will have to set
+;; `eldoc-in-minibuffer-own-frame-p' to non--nil.
+;;
+;; You can turn off at anytime eldoc support in minibuffer
+;; by setting `eldoc-in-minibuffer' to nil.
 
 ;;; Code:
 (require 'eldoc)