Consistently stylize eldoc as ElDoc in prose
* doc/emacs/custom.texi (Specifying File Variables): * doc/emacs/modes.texi (Major Modes): * doc/emacs/programs.texi (Lisp Doc): * etc/NEWS.22: * etc/NEWS.23: * lisp/progmodes/python.el: (python-eldoc-function): * test/lisp/progmodes/python-tests.el: Consistently capitalize eldoc as ElDoc rather than Eldoc.
This commit is contained in:
parent
136e931189
commit
6290850dac
7 changed files with 13 additions and 13 deletions
|
@ -1223,7 +1223,7 @@ other context has no special meaning.
|
||||||
disable a minor mode in a local variables list, use the @code{eval}
|
disable a minor mode in a local variables list, use the @code{eval}
|
||||||
keyword with a Lisp expression that runs the mode command
|
keyword with a Lisp expression that runs the mode command
|
||||||
(@pxref{Minor Modes}). For example, the following local variables
|
(@pxref{Minor Modes}). For example, the following local variables
|
||||||
list enables Eldoc mode (@pxref{Lisp Doc}) by calling
|
list enables ElDoc mode (@pxref{Lisp Doc}) by calling
|
||||||
@code{eldoc-mode} with no argument (calling it with an argument of 1
|
@code{eldoc-mode} with no argument (calling it with an argument of 1
|
||||||
would do the same), and disables Font Lock mode (@pxref{Font Lock}) by
|
would do the same), and disables Font Lock mode (@pxref{Font Lock}) by
|
||||||
calling @code{font-lock-mode} with an argument of @minus{}1.
|
calling @code{font-lock-mode} with an argument of @minus{}1.
|
||||||
|
|
|
@ -126,7 +126,7 @@ see which mode is actually being entered.
|
||||||
Mode hooks are commonly used to enable minor modes (@pxref{Minor
|
Mode hooks are commonly used to enable minor modes (@pxref{Minor
|
||||||
Modes}). For example, you can put the following lines in your init
|
Modes}). For example, you can put the following lines in your init
|
||||||
file to enable Flyspell minor mode in all text-based major modes
|
file to enable Flyspell minor mode in all text-based major modes
|
||||||
(@pxref{Spelling}), and Eldoc minor mode in Emacs Lisp mode
|
(@pxref{Spelling}), and ElDoc minor mode in Emacs Lisp mode
|
||||||
(@pxref{Lisp Doc}):
|
(@pxref{Lisp Doc}):
|
||||||
|
|
||||||
@example
|
@example
|
||||||
|
|
|
@ -1260,16 +1260,16 @@ the WoMan Info manual, which is distributed with Emacs.
|
||||||
to view the built-in documentation for the Lisp functions and
|
to view the built-in documentation for the Lisp functions and
|
||||||
variables that you want to use. @xref{Name Help}.
|
variables that you want to use. @xref{Name Help}.
|
||||||
|
|
||||||
@cindex Eldoc mode
|
@cindex ElDoc mode
|
||||||
@findex eldoc-mode
|
@findex eldoc-mode
|
||||||
@findex global-eldoc-mode
|
@findex global-eldoc-mode
|
||||||
Eldoc is a buffer-local minor mode that helps with looking up Lisp
|
ElDoc is a buffer-local minor mode that helps with looking up Lisp
|
||||||
documentation. When it is enabled, the echo area displays some useful
|
documentation. When it is enabled, the echo area displays some useful
|
||||||
information whenever there is a Lisp function or variable at point;
|
information whenever there is a Lisp function or variable at point;
|
||||||
for a function, it shows the argument list, and for a variable it
|
for a function, it shows the argument list, and for a variable it
|
||||||
shows the first line of the variable's documentation string. To
|
shows the first line of the variable's documentation string. To
|
||||||
toggle Eldoc mode, type @kbd{M-x eldoc-mode}. There's also a Global
|
toggle ElDoc mode, type @kbd{M-x eldoc-mode}. There's also a Global
|
||||||
Eldoc mode, which is turned on by default, and affects buffers, such
|
ElDoc mode, which is turned on by default, and affects buffers, such
|
||||||
as @samp{*scratch*}, whose major mode is Emacs Lisp or Lisp
|
as @samp{*scratch*}, whose major mode is Emacs Lisp or Lisp
|
||||||
Interaction (@w{@kbd{M-x global-eldoc-mode}} to turn it off globally).
|
Interaction (@w{@kbd{M-x global-eldoc-mode}} to turn it off globally).
|
||||||
|
|
||||||
|
|
|
@ -5239,7 +5239,7 @@ has no effect on systems with case-insensitive file names.
|
||||||
hooks. `run-mode-hooks' does this automatically.
|
hooks. `run-mode-hooks' does this automatically.
|
||||||
|
|
||||||
*** Major modes can define `eldoc-documentation-function'
|
*** Major modes can define `eldoc-documentation-function'
|
||||||
locally to provide Eldoc functionality by some method appropriate to
|
locally to provide ElDoc functionality by some method appropriate to
|
||||||
the language.
|
the language.
|
||||||
|
|
||||||
*** Use the new function `run-mode-hooks' to run the major mode's mode hook.
|
*** Use the new function `run-mode-hooks' to run the major mode's mode hook.
|
||||||
|
|
|
@ -1779,7 +1779,7 @@ to update it to the new VC.
|
||||||
If `default-directory' is a remote file name, subprocesses are started
|
If `default-directory' is a remote file name, subprocesses are started
|
||||||
on the corresponding remote system.
|
on the corresponding remote system.
|
||||||
|
|
||||||
*** Eldoc highlights the function argument under point
|
*** ElDoc highlights the function argument under point
|
||||||
with the face `eldoc-highlight-function-argument'.
|
with the face `eldoc-highlight-function-argument'.
|
||||||
|
|
||||||
*** In Etags, the --members option is now the default.
|
*** In Etags, the --members option is now the default.
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
;; Implements Syntax highlighting, Indentation, Movement, Shell
|
;; Implements Syntax highlighting, Indentation, Movement, Shell
|
||||||
;; interaction, Shell completion, Shell virtualenv support, Shell
|
;; interaction, Shell completion, Shell virtualenv support, Shell
|
||||||
;; package support, Shell syntax highlighting, Pdb tracking, Symbol
|
;; package support, Shell syntax highlighting, Pdb tracking, Symbol
|
||||||
;; completion, Skeletons, FFAP, Code Check, Eldoc, Imenu.
|
;; completion, Skeletons, FFAP, Code Check, ElDoc, Imenu.
|
||||||
|
|
||||||
;; Syntax highlighting: Fontification of code is provided and supports
|
;; Syntax highlighting: Fontification of code is provided and supports
|
||||||
;; python's triple quoted strings properly.
|
;; python's triple quoted strings properly.
|
||||||
|
@ -216,7 +216,7 @@
|
||||||
;; Code check: Check the current file for errors with `python-check'
|
;; Code check: Check the current file for errors with `python-check'
|
||||||
;; using the program defined in `python-check-command'.
|
;; using the program defined in `python-check-command'.
|
||||||
|
|
||||||
;; Eldoc: returns documentation for object at point by using the
|
;; ElDoc: returns documentation for object at point by using the
|
||||||
;; inferior python subprocess to inspect its documentation. As you
|
;; inferior python subprocess to inspect its documentation. As you
|
||||||
;; might guessed you should run `python-shell-send-buffer' from time
|
;; might guessed you should run `python-shell-send-buffer' from time
|
||||||
;; to time to get better results too.
|
;; to time to get better results too.
|
||||||
|
@ -4461,7 +4461,7 @@ See `python-check-command' for the default."
|
||||||
(format python-check-buffer-name command)))))
|
(format python-check-buffer-name command)))))
|
||||||
|
|
||||||
|
|
||||||
;;; Eldoc
|
;;; ElDoc
|
||||||
|
|
||||||
(defcustom python-eldoc-setup-code
|
(defcustom python-eldoc-setup-code
|
||||||
"def __PYDOC_get_help(obj):
|
"def __PYDOC_get_help(obj):
|
||||||
|
@ -4578,7 +4578,7 @@ fetching."
|
||||||
(with-timeout (python-eldoc-function-timeout
|
(with-timeout (python-eldoc-function-timeout
|
||||||
(if python-eldoc-function-timeout-permanent
|
(if python-eldoc-function-timeout-permanent
|
||||||
(progn
|
(progn
|
||||||
(message "Eldoc echo-area display muted in this buffer, see `python-eldoc-function'")
|
(message "ElDoc echo-area display muted in this buffer, see `python-eldoc-function'")
|
||||||
(setq python-eldoc-get-doc nil))
|
(setq python-eldoc-get-doc nil))
|
||||||
(message "`python-eldoc-function' timed out, see `python-eldoc-function-timeout'")))
|
(message "`python-eldoc-function' timed out, see `python-eldoc-function-timeout'")))
|
||||||
(python-eldoc--get-doc-at-point))))
|
(python-eldoc--get-doc-at-point))))
|
||||||
|
|
|
@ -3554,7 +3554,7 @@ def foo():
|
||||||
;;; Code check
|
;;; Code check
|
||||||
|
|
||||||
|
|
||||||
;;; Eldoc
|
;;; ElDoc
|
||||||
|
|
||||||
(ert-deftest python-eldoc--get-symbol-at-point-1 ()
|
(ert-deftest python-eldoc--get-symbol-at-point-1 ()
|
||||||
"Test paren handling."
|
"Test paren handling."
|
||||||
|
|
Loading…
Add table
Reference in a new issue