diff options
| author | Juanma Barranquero <lekktu@gmail.com> | 2007-09-26 11:55:46 +0000 |
|---|---|---|
| committer | Juanma Barranquero <lekktu@gmail.com> | 2007-09-26 11:55:46 +0000 |
| commit | d9d31f0a440e03d1a924e6835ec27b91afb493e1 (patch) | |
| tree | 41f5dd046c5fd80c19f12ee76ebef5530a231773 /lisp/emacs-lisp/eldoc.el | |
| parent | 0f3955d99ce7d1b50bfc8b7b5a5152d871f9e44c (diff) | |
(eldoc-message-commands-table-size, eldoc-message-commands,
eldoc-current-idle-delay, eldoc-function-argstring-format):
Fix typos in docstrings.
Diffstat (limited to 'lisp/emacs-lisp/eldoc.el')
| -rw-r--r-- | lisp/emacs-lisp/eldoc.el | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/lisp/emacs-lisp/eldoc.el b/lisp/emacs-lisp/eldoc.el index 1d2441f884..10eb821d4e 100644 --- a/lisp/emacs-lisp/eldoc.el +++ b/lisp/emacs-lisp/eldoc.el @@ -109,7 +109,7 @@ truncated to make more of the arglist or documentation string visible." ;;; No user options below here. (defvar eldoc-message-commands-table-size 31 - "This is used by eldoc-add-command to initialize eldoc-message-commands + "This is used by `eldoc-add-command' to initialize `eldoc-message-commands' as an obarray. It should probably never be necessary to do so, but if you choose to increase the number of buckets, you must do so before loading @@ -121,7 +121,7 @@ Remember to keep it a prime number to improve hash performance.") "Commands after which it is appropriate to print in the echo area. Eldoc does not try to print function arglists, etc. after just any command, because some commands print their own messages in the echo area and these -functions would instantly overwrite them. But self-insert-command as well +functions would instantly overwrite them. But `self-insert-command' as well as most motion commands are good candidates. This variable contains an obarray of symbols; do not manipulate it directly. Instead, use `eldoc-add-command' and `eldoc-remove-command'.") @@ -137,7 +137,7 @@ directly. Instead, use `eldoc-add-command' and `eldoc-remove-command'.") (defvar eldoc-timer nil "eldoc's timer object.") (defvar eldoc-current-idle-delay eldoc-idle-delay - "idle time delay currently in use by timer. + "Idle time delay currently in use by timer. This is used to determine if `eldoc-idle-delay' is changed by the user.") @@ -474,7 +474,7 @@ ARGLIST is either a string, or a list of strings or symbols." (format "(%s)" arglist))) (defun eldoc-function-argstring-format (argstring) - "Apply `eldoc-argument-case' to each word in argstring. + "Apply `eldoc-argument-case' to each word in ARGSTRING. The words \"&rest\", \"&optional\" are returned unchanged." (mapconcat (lambda (s) (if (member s '("&optional" "&rest")) |