diff lisp/emacs-lisp/edebug.el @ 80756:76e75acf7e4e

Fix typos (sync from the trunk). * facemenu.el (facemenu-unlisted-faces): Fix obsolescence declaration. * hi-lock.el (hi-lock-mode): Fix typo in docstring. * icomplete.el (icomplete-compute-delay, icomplete-get-keys): Doc fixes. (icomplete-delay-completions-threshold): Fix typo in docstring. * speedbar.el (speedbar-stealthy-function-list) (speedbar-verbosity-level, speedbar-supported-extension-expressions) (speedbar-update-current-file, speedbar-add-indicator) (speedbar-tag-expand): Reflow docstrings. (speedbar-use-imenu-flag, speedbar-use-tool-tips-flag) (speedbar-ignored-directory-regexp, speedbar-file-unshown-regexp) (speedbar-file-regexp, speedbar-message, speedbar-item-info) (speedbar-files-item-info, speedbar-fetch-replacement-function) (speedbar-maybe-add-localized-support) (speedbar-generic-list-positioned-group-p, speedbar-insert-generic-list) (speedbar-extract-one-symbol, speedbar-recenter-to-top) (speedbar-recenter, speedbar-separator-face): Fix typos in docstrings. (speedbar-ignored-directory-expressions, speedbar-handle-delete-frame) (speedbar-show-info-under-mouse, speedbar-directory-buttons) (speedbar-check-vc-this-line, speedbar-files-line-directory) (speedbar-buffer-buttons, speedbar-buffer-buttons-temp) (speedbar-buffers-line-directory): Doc fixes. * tool-bar.el (tool-bar-add-item): Fix typo in docstring. * emacs-lisp/edebug.el (edebug-unwrap*, edebug-signal) (edebug-restore-status): Doc fixes. (edebug-gensym, edebug-top-level-nonstop, edebug-eval-display) (edebug-eval-result-list, edebug-eval-redisplay, edebug) (edebug-trace): Fix typos in docstrings. * emulation/tpu-edt.el (tpu-match-beginning, tpu-match-end) (tpu-check-match, tpu-goto-breadcrumb, tpu-reset-screen-size) (tpu-toggle-overwrite-mode, tpu-include, tpu-get, tpu-what-line) (tpu-insert-escape, tpu-insert-formfeed, tpu-end-define-macro-key) (tpu-check-search-case, tpu-select, tpu-unselect, tpu-trim-line-ends) (tpu-toggle-control-keys): Fix typos in docstrings. (tpu-kill-buffer): Doc fix. (tpu-make-file-buffer-list, tpu-toggle-regexp, tpu-cut) (tpu-append-region, tpu-delete-current-char, tpu-emacs-replace): Reflow docstrings. * eshell/em-smart.el (eshell-review-quick-commands): Doc fix. * eshell/esh-arg.el (eshell-quote-backslash): Fix typo in docstring. * play/solitaire.el (solitaire, solitaire-mode-map, solitaire-mode-hook) (solitaire-mode, solitaire, solitaire-solve): Fix typos in docstrings. * progmodes/gdb-ui.el (gdb-source-info): Fix typo in docstring. * progmodes/python.el (python-comment-line-p, python-blank-line-p) (python-skip-out): Doc fixes.

--- a/lisp/emacs-lisp/edebug.el	Mon Aug 25 20:55:05 2008 +0000
+++ b/lisp/emacs-lisp/edebug.el	Tue Aug 26 11:02:51 2008 +0000
@@ -273,8 +273,8 @@
 
 (defun edebug-gensym (&optional prefix)
   "Generate a fresh uninterned symbol.
-There is an  optional argument, PREFIX.  PREFIX is the
-string that begins the new name. Most people take just the default,
+There is an optional argument, PREFIX.  PREFIX is the string
+that begins the new name.  Most people take just the default,
 except when debugging needs suggest otherwise."
   (if (null prefix)
       (setq prefix "G"))
@@ -1278,7 +1278,7 @@
     sexp))
 
 (defun edebug-unwrap* (sexp)
-  "Return the sexp recursively unwrapped."
+  "Return the SEXP recursively unwrapped."
   (let ((new-sexp (edebug-unwrap sexp)))
     (while (not (eq sexp new-sexp))
       (setq sexp new-sexp
@@ -2231,7 +2231,8 @@
 This is the Edebug replacement for the standard `signal'.  It should
 only be active while Edebug is.  It checks `debug-on-error' to see
 whether it should call the debugger.  When execution is resumed, the
-error is signaled again."
+error is signaled again.
+\n(fn SIGNAL-NAME DATA)"
   (if (and (listp debug-on-error) (memq edebug-signal-name debug-on-error))
       (edebug 'error (cons edebug-signal-name edebug-signal-data)))
   ;; If we reach here without another non-local exit, then send signal again.
@@ -2342,7 +2343,7 @@
 
 (defun edebug-restore-status (var status)
   "Reset VAR based on STATUS.
-STATUS should be a list you got from `edebug-var-status'."
+STATUS should be a list returned by `edebug-var-status'."
   (let ((locus (car status))
 	(value (cdr status)))
     (cond ((bufferp locus)
@@ -3502,7 +3503,7 @@
 
 (defun edebug-top-level-nonstop ()
   "Set mode to Go-nonstop, and exit to top-level.
-This is useful for exiting even if unwind-protect code may be executed."
+This is useful for exiting even if `unwind-protect' code may be executed."
   (interactive)
   (setq edebug-execution-mode 'Go-nonstop)
   (top-level))
@@ -3937,7 +3938,7 @@
 ;; A list of expressions and their evaluations is displayed in *edebug*.
 
 (defun edebug-eval-result-list ()
-  "Return a list of evaluations of edebug-eval-list"
+  "Return a list of evaluations of `edebug-eval-list'."
   ;; Assumes in outside environment.
   ;; Don't do any edebug things now.
   (let ((edebug-execution-mode 'Go-nonstop)
@@ -3971,7 +3972,7 @@
 ;; with calls in user functions, e.g. (edebug-eval-display)
 
 (defun edebug-eval-display (edebug-eval-result-list)
-  "Display expressions and evaluations in EVAL-LIST.
+  "Display expressions and evaluations in EDEBUG-EVAL-RESULT-LIST.
 It modifies the context by popping up the eval display."
   (if edebug-eval-result-list
       (progn
@@ -3981,7 +3982,7 @@
 
 (defun edebug-eval-redisplay ()
   "Redisplay eval list in outside environment.
-May only be called from within edebug-recursive-edit."
+May only be called from within `edebug-recursive-edit'."
   (edebug-create-eval-buffer)
   (edebug-outside-excursion
    (edebug-eval-display-list (edebug-eval-result-list))
@@ -4073,9 +4074,9 @@
 ;; edebug is not dependent on this, yet.
 
 (defun edebug (&optional edebug-arg-mode &rest debugger-args)
-  "Replacement for debug.
-If we are running an edebugged function,
-show where we last were.  Otherwise call debug normally."
+  "Replacement for `debug'.
+If we are running an edebugged function,show where we last were.
+Otherwise call `debug' normally."
 ;;  (message "entered: %s  depth: %s  edebug-recursion-depth: %s"
 ;;	   edebug-entered (recursion-depth) edebug-recursion-depth) (sit-for 1)
   (if (and edebug-entered  ; anything active?
@@ -4175,7 +4176,7 @@
 
 
 (defun edebug-trace (fmt &rest args)
-  "Convenience call to edebug-trace-display using edebug-trace-buffer"
+  "Convenience call to `edebug-trace-display' using `edebug-trace-buffer'."
   (apply 'edebug-trace-display edebug-trace-buffer fmt args))