Mercurial > emacs
changeset 106697:ac408704629c
lisp/*: Fix typos in docstrings and messages.
| author | Juanma Barranquero <lekktu@gmail.com> |
|---|---|
| date | Sat, 02 Jan 2010 02:05:44 +0100 |
| parents | 9084997e41f6 |
| children | c829707235e8 |
| files | lisp/ChangeLog lisp/bookmark.el lisp/cedet/semantic/db-typecache.el lisp/ediff-mult.el lisp/mpc.el lisp/net/imap-hash.el lisp/play/gomoku.el lisp/progmodes/gdb-ui.el lisp/progmodes/idlw-help.el lisp/progmodes/octave-mod.el |
| diffstat | 10 files changed, 176 insertions(+), 123 deletions(-) [+] |
line wrap: on
line diff
--- a/lisp/ChangeLog Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/ChangeLog Sat Jan 02 02:05:44 2010 +0100 @@ -1,3 +1,55 @@ +2010-01-02 Juanma Barranquero <lekktu@gmail.com> + + * bookmark.el (bookmarks-already-loaded): Doc fix (don't use `iff'). + (bookmark-yank-point, bookmark-bmenu-check-position): + Fix typos in docstrings. + (bookmark-save-flag, bookmark-bmenu-toggle-filenames) + (bookmark-name-from-full-record, bookmark-get-position) + (bookmark-set-position, bookmark-set, bookmark-handle-bookmark) + (bookmark-delete, bookmark-save, bookmark-save, bookmark-bmenu-mode): + Remove useless quoting of parenthesis, etc. in docstrings. + + * ediff-mult.el (ediff-prepare-meta-buffer): Fix typo in help message. + (ediff-append-custom-diff): Fix typo in error message. + (ediff-meta-mark-equal-files): Fix typos in messages. + + * mpc.el (mpc-playlist-delete): Fix typo in error messages. + + * cedet/semantic/db-typecache.el (semanticdb-typecache-find-default): + Fix typo in docstring. + + * net/imap-hash.el (imap-hash-make): Doc fix. + (imap-hash-test): Fix typo in error message; reflow docstring. + (imap-hash-p, imap-hash-get, imap-hash-put, imap-hash-make-message) + (imap-hash-count, imap-hash-server, imap-hash-port, imap-hash-ssl) + (imap-hash-mailbox, imap-hash-user, imap-hash-password): + Fix typos in docstrings. + (imap-hash-open-connection): Fix typo in error message. + + * play/gomoku.el (gomoku): Fix typos in docstring. + + * progmodes/gdb-ui.el (gdb-location-alist): Reflow docstring. + (gdb-jsonify-buffer): Fix typos in docstring. + (gdb-goto-breakpoint): Fix typo in error message. + ("Display Other Windows"): Fix typo in help message. + (gdb-speedbar-expand-node): Fix typo in question. + + * progmodes/idlw-help.el (idlwave-help-browse-url-available) + (idlwave-html-system-help-location, idlwave-html-help-location) + (idlwave-help-browser-function, idlwave-help-browser-generic-program) + (idlwave-help-browser-generic-args, idlwave-help-directory) + (idlwave-html-help-is-available, idlwave-help-mode-line-indicator) + (idlwave-help-mode-map, idlwave-help-mode, idlwave-do-context-help) + (idlwave-online-help, idlwave-help-html-link) + (idlwave-help-show-help-frame, idlwave-help-assistant-command): + Fix typos in docstrings. + (idlwave-help-with-source, idlwave-help-find-routine-definition): + Reflow docstrings. + (idlwave-help-assistant-start): Fix typo in error message. + + * progmodes/octave-mod.el (octave-mode, octave-electric-semi) + (octave-electric-space): Fix typos in docstrings. + 2010-01-01 Chong Yidong <cyd@stupidchicken.com> * files.el (minibuffer-with-setup-hook): Doc fix (Bug#5149).
--- a/lisp/bookmark.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/bookmark.el Sat Jan 02 02:05:44 2010 +0100 @@ -107,17 +107,17 @@ (defcustom bookmark-save-flag t "Controls when Emacs saves bookmarks to a file. --> nil means never save bookmarks, except when `bookmark-save' is - explicitly called \(\\[bookmark-save]\). + explicitly called (\\[bookmark-save]). --> t means save bookmarks when Emacs is killed. --> Otherwise, it should be a number that is the frequency with which - the bookmark list is saved \(i.e.: the number of times which + the bookmark list is saved (i.e.: the number of times which Emacs' bookmark list may be modified before it is automatically - saved.\). If it is a number, Emacs will also automatically save + saved.). If it is a number, Emacs will also automatically save bookmarks when it is killed. Therefore, the way to get it to save every time you make or delete a -bookmark is to set this variable to 1 \(or 0, which produces the same -behavior.\) +bookmark is to set this variable to 1 (or 0, which produces the same +behavior.) To specify the file in which to save them, modify the variable `bookmark-default-file', which is `~/.emacs.bmk' by default." @@ -186,7 +186,7 @@ This may result in truncated bookmark names. To disable this, put the following in your `.emacs' file: -\(setq bookmark-bmenu-toggle-filenames nil\)" +\(setq bookmark-bmenu-toggle-filenames nil)" :type 'boolean :group 'bookmark) @@ -292,7 +292,7 @@ for instance. HANDLER must accept a bookmark as argument.") (defvar bookmarks-already-loaded nil - "Non-nil iff bookmarks have been loaded from `bookmark-default-file'.") + "Non-nil if and only if bookmarks have been loaded from `bookmark-default-file'.") ;; more stuff added by db. @@ -322,7 +322,7 @@ (defvar bookmark-yank-point 0 "The next point from which to pull source text for `bookmark-yank-word'. -This point is in `bookmark-curent-buffer'.") +This point is in `bookmark-current-buffer'.") (defvar bookmark-quit-flag nil @@ -336,7 +336,7 @@ (defun bookmark-name-from-full-record (full-record) - "Return name of FULL-RECORD \(an alist element instead of a string\)." + "Return name of FULL-RECORD (an alist element instead of a string)." (car full-record)) @@ -414,13 +414,13 @@ (defun bookmark-get-position (bookmark) - "Return the position \(i.e.: point\) of BOOKMARK, or nil if none. + "Return the position (i.e.: point) of BOOKMARK, or nil if none. BOOKMARK may be a bookmark name (a string) or a bookmark record." (bookmark-prop-get bookmark 'position)) (defun bookmark-set-position (bookmark position) - "Set the position \(i.e.: point\) of BOOKMARK to POSITION. + "Set the position (i.e.: point) of BOOKMARK to POSITION. BOOKMARK may be a bookmark name (a string) or a bookmark record." (bookmark-prop-set bookmark 'position position)) @@ -800,9 +800,9 @@ large document. If there is no prior bookmark for this document, then C-u inserts an appropriate name based on the buffer or file. -Use \\[bookmark-delete] to remove bookmarks \(you give it a name and +Use \\[bookmark-delete] to remove bookmarks (you give it a name and it removes only the first instance of a bookmark with that name from -the list of bookmarks.\)" +the list of bookmarks.)" (interactive (list nil current-prefix-arg)) (let* ((record (bookmark-make-record)) (default (car record))) @@ -953,7 +953,7 @@ (defun bookmark-yank-word () "Get the next word from buffer `bookmark-current-buffer' and append it to the name of the bookmark currently being set, advancing -`bookmark-yank-point' by one word." +`bookmark-yank-point' by one word." (interactive) (let ((string (with-current-buffer bookmark-current-buffer (goto-char bookmark-yank-point) @@ -1125,7 +1125,7 @@ 'bookmark-default-handler) (bookmark-get-bookmark bookmark))) (message - "Bookmark not relocated; consider removing it \(%s\)." + "Bookmark not relocated; consider removing it (%s)." bookmark) (signal (car err) (cdr err)))))))))) ;; Added by db. @@ -1248,7 +1248,7 @@ "New name: " nil (let ((now-map (copy-keymap minibuffer-local-map))) - (define-key now-map "\C-w" 'bookmark-yank-word) + (define-key now-map "\C-w" 'bookmark-yank-word) now-map) nil 'bookmark-history)))) @@ -1290,8 +1290,8 @@ Removes only the first instance of a bookmark with that name. If there are one or more other bookmarks with the same name, they will -not be deleted. Defaults to the \"current\" bookmark \(that is, the -one most recently used in this file, if any\). +not be deleted. Defaults to the \"current\" bookmark (that is, the +one most recently used in this file, if any). Optional second arg BATCH means don't update the bookmark list buffer, probably because we were called from there." (interactive @@ -1342,7 +1342,7 @@ "Save currently defined bookmarks. Saves by default in the file defined by the variable `bookmark-default-file'. With a prefix arg, save it in file FILE -\(second argument\). +\(second argument). If you are calling this from Lisp, the two arguments are PARG and FILE, and if you just want it to write to the default file, then @@ -1351,7 +1351,7 @@ user will be interactively queried for a file to save in. When you want to load in the bookmarks from a file, use -\`bookmark-load\', \\[bookmark-load]. That function will prompt you +`bookmark-load', \\[bookmark-load]. That function will prompt you for a file, defaulting to the file defined by variable `bookmark-default-file'." (interactive "P") @@ -1389,7 +1389,7 @@ ;; Rather than a single call to `pp' we make one per bookmark. ;; Apparently `pp' has a poor algorithmic complexity, so this ;; scales a lot better. bug#4485. - (dolist (i bookmark-alist) (pp i (current-buffer))) + (dolist (i bookmark-alist) (pp i (current-buffer))) (insert ")") (let ((version-control (cond @@ -1625,8 +1625,8 @@ \\[bookmark-bmenu-other-window] -- select this bookmark in another window, so the bookmark menu bookmark remains visible in its window. \\[bookmark-bmenu-switch-other-window] -- switch the other window to this bookmark. -\\[bookmark-bmenu-rename] -- rename this bookmark \(prompts for new name\). -\\[bookmark-bmenu-relocate] -- relocate this bookmark's file \(prompts for new file\). +\\[bookmark-bmenu-rename] -- rename this bookmark (prompts for new name). +\\[bookmark-bmenu-relocate] -- relocate this bookmark's file (prompts for new file). \\[bookmark-bmenu-delete] -- mark this bookmark to be deleted, and move down. \\[bookmark-bmenu-delete-backwards] -- mark this bookmark to be deleted, and move up. \\[bookmark-bmenu-execute-deletions] -- delete bookmarks marked with `\\[bookmark-bmenu-delete]'. @@ -1731,7 +1731,7 @@ "If point is not on a bookmark line, move it to one. If before the first bookmark line, move it to the first. If after the last, move it to the last. -Return `bookmark-alist'" +Return `bookmark-alist'." ;; FIXME: The doc string originally implied that this returns nil if ;; not on a bookmark, which is false. Is there any real reason to ;; return `bookmark-alist'? This seems to be called in a few places @@ -2101,7 +2101,7 @@ (when bookmark-quit-flag ; C-g hit restore menu list. (bookmark-bmenu-list) (bookmark-bmenu-goto-bookmark bmk)) (setq bookmark-quit-flag nil)))) - + (defun bookmark-bmenu-goto-bookmark (name) "Move point to bookmark with name NAME." (goto-char (point-min)) @@ -2109,7 +2109,7 @@ (while (not (equal name (bookmark-bmenu-bookmark))) (forward-line 1)) (forward-line 0)) - + ;;; Menu bar stuff. Prefix is "bookmark-menu".
--- a/lisp/cedet/semantic/db-typecache.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/cedet/semantic/db-typecache.el Sat Jan 02 02:05:44 2010 +0100 @@ -111,7 +111,7 @@ ) (object-add-to-list cache 'dependants dep))) -(defun semanticdb-typecache-length(thing) +(defun semanticdb-typecache-length (thing) "How long is THING? Debugging function." (cond ((semanticdb-typecache-child-p thing) @@ -383,7 +383,7 @@ (defun semanticdb-typecache-find-default (type &optional path find-file-match) "Default implementation of `semanticdb-typecache-find'. TYPE is the datatype to find. -PATH is the search path.. which should be one table object. +PATH is the search path, which should be one table object. If FIND-FILE-MATCH is non-nil, then force the file belonging to the found tag to be loaded." (semanticdb-typecache-find-method (or path semanticdb-current-table)
--- a/lisp/ediff-mult.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/ediff-mult.el Sat Jan 02 02:05:44 2010 +0100 @@ -330,7 +330,7 @@ ;; This nil is a placeholder for eq-indicator. It is either nil or =. ;; If it is discovered that this file is = to some other ;; file in the same session, eq-indicator is changed to `='. -;; Curently, the eq-indicator is used only for 2 and 3-file jobs. +;; Currently, the eq-indicator is used only for 2 and 3-file jobs. (defun ediff-make-new-meta-list-element (obj1 obj2 obj3) (list nil nil (list obj1 nil) (list obj2 nil) (list obj3 nil))) @@ -879,7 +879,7 @@ (define-key ediff-meta-buffer-map [menu-bar ediff-meta-mode ediff-mark-for-operation-at-pos] '(menu-item "Mark for group operation" ediff-mark-for-operation-at-pos - :help "Mark session for a group operation. With prefix arg, unmark.")) + :help "Mark session for a group operation. With prefix arg, unmark")) (define-key ediff-meta-buffer-map [menu-bar ediff-meta-mode ediff-unmark-all-for-hiding] @@ -1739,7 +1739,7 @@ (insert "\n"))) (t (ediff-kill-buffer-carefully meta-diff-buff) - (error "Session %d compares versions of file. Such session must be active to enable multifile patch collection" sessionNum ))) + (error "Session %d compares versions of file. Such session must be active to enable multifile patch collection" sessionNum ))) )) (defun ediff-collect-custom-diffs () @@ -2421,7 +2421,7 @@ (let ((list (cdr ediff-meta-list)) marked1 marked2 marked3 fileinfo1 fileinfo2 fileinfo3 elt) - (message "Comparing files ...") + (message "Comparing files...") (while (setq elt (car list)) (setq fileinfo1 (ediff-get-session-objA elt) fileinfo2 (ediff-get-session-objB elt) @@ -2448,7 +2448,7 @@ (ediff-mark-session-for-operation elt 'mark)) )) (setq list (cdr list))) - (message "Comparing files ... Done")) + (message "Comparing files... Done")) (setq ediff-recurse-to-subdirectories nil) (ediff-update-meta-buffer (current-buffer) 'must-redraw))
--- a/lisp/mpc.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/mpc.el Sat Jan 02 02:05:44 2010 +0100 @@ -1728,7 +1728,7 @@ "Remove the selected songs from the playlist." (interactive) (unless mpc-songs-playlist - (error "The selected songs aren't part of a playlist.")) + (error "The selected songs aren't part of a playlist")) (let ((song-poss (mapcar #'cdr (mpc-songs-selection)))) (mpc-cmd-delete song-poss mpc-songs-playlist) (mpc-songs-refresh)
--- a/lisp/net/imap-hash.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/net/imap-hash.el Sat Jan 02 02:05:44 2010 +0100 @@ -67,16 +67,16 @@ (imap-hash-remove-cr-followed-by-lf)))) (defun imap-hash-make (server port mailbox &optional user password ssl) - "Makes a new imap-hash object using SERVER, PORT, and MAILBOX. -SSL, USER, PASSWORD are optional. + "Make a new imap-hash object using SERVER, PORT, and MAILBOX. +USER, PASSWORD and SSL are optional. The test is set to t, meaning all messages are considered." (when (and server port mailbox) - (list :server server :port port :mailbox mailbox - :ssl ssl :user user :password password + (list :server server :port port :mailbox mailbox + :ssl ssl :user user :password password :test t))) (defun imap-hash-p (iht) - "Checks whether IHT is a valid imap-hash." + "Check whether IHT is a valid imap-hash." (and (imap-hash-server iht) (imap-hash-port iht) @@ -95,7 +95,7 @@ (defun imap-hash-get (key iht &optional refetch) "Get the value for KEY in the imap-hash IHT. Requires either `imap-hash-fetch' to be called beforehand -(e.g. by `imap-hash-map'), or REFETCH to be t. +\(e.g. by `imap-hash-map'), or REFETCH to be t. Returns a list of the headers (an alist, see `imap-hash-map') and the body of the message as a string. Also see `imap-hash-test'." @@ -106,13 +106,13 @@ (list (imap-hash-get-headers (imap-hash-data-headers details)) - (imap-hash-get-body + (imap-hash-get-body (imap-hash-data-body details)))))) (defun imap-hash-put (value iht &optional key) - "Put VALUE in the imap-hash IHT. Returns the new key. + "Put VALUE in the imap-hash IHT. Return the new key. If KEY is given, removes it. -VALUE can be a list of the headers (an alist, see `imap-hash-map') +VALUE can be a list of the headers (an alist, see `imap-hash-map') and the body of the message as a string. It can also be a uid, in which case `imap-hash-get' will be called to get the value. Also see `imap-hash-test'." @@ -121,19 +121,19 @@ newuid) (when value (with-temp-buffer - (funcall 'imap-hash-make-message - (nth 0 value) + (funcall 'imap-hash-make-message + (nth 0 value) (nth 1 value) nil) (setq newuid (nth 1 (imap-message-append - (imap-hash-mailbox iht) + (imap-hash-mailbox iht) (current-buffer) nil nil server-buffer))) (when key (imap-hash-rem key iht)))) newuid)) (defun imap-hash-make-message (headers body &optional overrides) "Make a message with HEADERS and BODY suitable for `imap-append', -using `message-setup'.. +using `message-setup'. Look in the alist OVERRIDES for header overrides as per `imap-hash-headers'." ;; don't insert a signature no matter what (let (message-signature) @@ -154,7 +154,7 @@ (defun imap-hash-rem (key iht) "Remove KEY in the imap-hash IHT. Also see `imap-hash-test'. Requires `imap-hash-fetch' to have -been called and the imap-hash server buffer to be current, +been called and the imap-hash server buffer to be current, so it's best to use it inside `imap-hash-map'. The key will not be found on the next `imap-hash-map' call." (with-current-buffer (imap-hash-get-buffer iht) @@ -172,7 +172,7 @@ (with-temp-buffer (insert (or text-headers "")) (imap-hash-remove-cr-followed-by-lf) - (mapcar (lambda (header) + (mapcar (lambda (header) (cons header (message-fetch-field (format "%s" header)))) imap-hash-headers))) @@ -199,11 +199,11 @@ (headers (imap-hash-data-headers details)) (hlist (imap-hash-get-headers headers)) (runit (cond - ((stringp test) + ((stringp test) (string-match - test + test (format "%s" (aget hlist 'Subject)))) - ((functionp test) + ((functionp test) (funcall test hlist)) ;; otherwise, return test itself (t test)))) @@ -218,7 +218,7 @@ "UID"))))) (defun imap-hash-count (iht) - "Counts the number of messages in the imap-hash IHT. + "Count the number of messages in the imap-hash IHT. Also see `imap-hash-test'. It uses `imap-hash-map' so just use that function if you want to do more than count the elements." (length (imap-hash-map (lambda (a b c)) iht t))) @@ -226,36 +226,36 @@ (defalias 'imap-hash-size 'imap-hash-count) (defun imap-hash-test (iht) - "Returns the test used by `imap-hash-map' for IHT. + "Return the test used by `imap-hash-map' for IHT. When the test is t, any key will be a candidate. -When the test is a string, messages will be filtered on that string as a regexp -against the subject. -When the test is a function, messages will be filtered with it. +When the test is a string, messages will be filtered on that string as a +regexp against the subject. +When the test is a function, messages will be filtered with it. The function is passed the message headers (see `imap-hash-get-headers')." (plist-get iht :test)) -(defun imap-hash-server (iht) - "Returns the server used by the imap-hash IHT." +(defun imap-hash-server (iht) + "Return the server used by the imap-hash IHT." (plist-get iht :server)) -(defun imap-hash-port (iht) - "Returns the port used by the imap-hash IHT." +(defun imap-hash-port (iht) + "Return the port used by the imap-hash IHT." (plist-get iht :port)) -(defun imap-hash-ssl (iht) - "Returns the SSL need for the imap-hash IHT." +(defun imap-hash-ssl (iht) + "Return the SSL need for the imap-hash IHT." (plist-get iht :ssl)) (defun imap-hash-mailbox (iht) - "Returns the mailbox used by the imap-hash IHT." + "Return the mailbox used by the imap-hash IHT." (plist-get iht :mailbox)) -(defun imap-hash-user (iht) - "Returns the username used by the imap-hash IHT." +(defun imap-hash-user (iht) + "Return the username used by the imap-hash IHT." (plist-get iht :user)) -(defun imap-hash-password (iht) - "Returns the password used by the imap-hash IHT." +(defun imap-hash-password (iht) + "Return the password used by the imap-hash IHT." (plist-get iht :password)) (defun imap-hash-open-connection (iht) @@ -263,16 +263,16 @@ (let* ((server (imap-hash-server iht)) (port (imap-hash-port iht)) (ssl-need (imap-hash-ssl iht)) - (auth-need (not (and (imap-hash-user iht) + (auth-need (not (and (imap-hash-user iht) (imap-hash-password iht)))) ;; this will not be needed if auth-need is t (auth-info (when auth-need - (auth-source-user-or-password - '("login" "password") + (auth-source-user-or-password + '("login" "password") server port))) - (auth-user (or (imap-hash-user iht) + (auth-user (or (imap-hash-user iht) (nth 0 auth-info))) - (auth-passwd (or (imap-hash-password iht) + (auth-passwd (or (imap-hash-password iht) (nth 1 auth-info))) (imap-logout-timeout nil)) @@ -283,7 +283,7 @@ ;; (debug "after opening server: opened+state" (imap-opened (current-buffer)) imap-state) ;; (debug "authenticating" auth-user auth-passwd) (if (not (imap-capability 'IMAP4rev1)) - (error "IMAP server does not support IMAP4r1, it won't work, sorry.") + (error "IMAP server does not support IMAP4r1, it won't work, sorry") (imap-authenticate auth-user auth-passwd) (imap-id) ;; (debug "after authenticating: opened+state" (imap-opened (current-buffer)) imap-state) @@ -314,8 +314,8 @@ "Fetch all the messages for imap-hash IHT. Get only the headers if HEADERS-ONLY is not nil." (with-current-buffer (imap-hash-get-buffer iht) - (let ((range (if messages - (list + (let ((range (if messages + (list (imap-range-to-message-set messages) (imap-range-to-message-set messages)) '("1:*" . "1,*:*")))) @@ -329,9 +329,9 @@ (imap-fetch-safe range (concat (format "(UID RFC822.SIZE BODY %s " (if headers-only "" "BODY.PEEK[TEXT]")) - (format "BODY.PEEK[HEADER.FIELDS %s])" + (format "BODY.PEEK[HEADER.FIELDS %s])" imap-hash-headers)))))) - + (provide 'imap-hash) ;;; imap-hash.el ends here
--- a/lisp/play/gomoku.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/play/gomoku.el Sat Jan 02 02:05:44 2010 +0100 @@ -730,12 +730,12 @@ (defun gomoku (&optional n m) "Start a Gomoku game between you and Emacs. -If a game is in progress, this command allow you to resume it. +If a game is in progress, this command allows you to resume it. If optional arguments N and M are given, an N by M board is used. If prefix arg is given for N, M is prompted for. You and Emacs play in turn by marking a free square. You mark it with X -and Emacs marks it with O. The winner is the first to get five contiguous +and Emacs marks it with O. The winner is the first to get five contiguous marks horizontally, vertically or in diagonal. You play by moving the cursor over the square you choose and hitting
--- a/lisp/progmodes/gdb-ui.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/progmodes/gdb-ui.el Sat Jan 02 02:05:44 2010 +0100 @@ -140,8 +140,8 @@ (defvar gdb-server-prefix nil) (defvar gdb-flush-pending-output nil) (defvar gdb-location-alist nil - "Alist of breakpoint numbers and full filenames. Only used for files that -Emacs can't find.") + "Alist of breakpoint numbers and full filenames. +Only used for files that Emacs can't find.") (defvar gdb-active-process nil "GUD tooltips display variable values when t, and macro definitions otherwise.") (defvar gdb-recording nil @@ -520,7 +520,7 @@ (not (display-graphic-p))))) ;; If expr is a macro for a function don't print because of possible dangerous -;; side-effects. Also printing a function within a tooltip generates an +;; side-effects. Also printing a function within a tooltip generates an ;; unexpected starting annotation (phase error). (defun gdb-tooltip-print-1 (expr) (with-current-buffer (gdb-get-buffer 'gdb-partial-output-buffer) @@ -1079,7 +1079,7 @@ (if (or (<= (string-to-number children) gdb-max-children) (y-or-n-p (format - "%s has %s children. Continue? " expr children))) + "%s has %s children. Continue? " expr children))) (if (and (eq (buffer-local-value 'gud-minor-mode gud-comint-buffer) 'gdba) (string-equal gdb-version "pre-6.4")) @@ -1488,7 +1488,7 @@ (let ((gud-running nil)) (gdb-invalidate-frames) (unless (or gdb-register-names - (string-equal gdb-version "pre-6.4")) + (string-equal gdb-version "pre-6.4")) (gdb-enqueue-input (list "server interpreter mi -data-list-register-names\n" 'gdb-get-register-names)))) @@ -1815,13 +1815,13 @@ replaced with semicolons. If FIX-KEY is non-nil, strip all \"FIX-KEY=\" occurences from -partial output. This is used to get rid of useless keys in lists -in MI messages, e.g.: [key=.., key=..]. -stack-list-frames and +partial output. This is used to get rid of useless keys in lists +in MI messages, e.g.: [key=.., key=..]. -stack-list-frames and -break-info are examples of MI commands which issue such responses. If FIX-LIST is non-nil, \"FIX-LIST={..}\" is replaced with -\"FIX-LIST=[..]\" prior to parsing. This is used to fix broken +\"FIX-LIST=[..]\" prior to parsing. This is used to fix broken -break-info output when it contains breakpoint script field incompatible with GDB/MI output syntax." (save-excursion @@ -1897,7 +1897,7 @@ ;; annotation rule binding of whatever gdb sends to tell us this command ;; might have changed it's output. ;; -;; NAME is the function name. DEMAND-PREDICATE tests if output is really needed. +;; NAME is the function name. DEMAND-PREDICATE tests if output is really needed. ;; GDB-COMMAND is a string of such. OUTPUT-HANDLER is the function bound to the ;; input in the input queue (see comment about ``gdb communications'' above). @@ -2270,7 +2270,7 @@ (defmacro gdb-propertize-header (name buffer help-echo mouse-face face) `(propertize ,name - 'help-echo ,help-echo + 'help-echo ,help-echo 'mouse-face ',mouse-face 'face ',face 'local-map @@ -2389,7 +2389,7 @@ (goto-char (point-min)) (forward-line (1- (string-to-number line))) (set-window-point window (point)))))) - (error "No location specified.")))) + (error "No location specified")))) ;; Frames buffer. This displays a perpetually correct backtrace @@ -3284,7 +3284,7 @@ :button (:toggle . gdb-use-separate-io-buffer))) (define-key menu [gdb-many-windows] '(menu-item "Display Other Windows" gdb-many-windows - :help "Toggle display of locals, stack and breakpoint information" + :help "Toggle display of locals, stack and breakpoint information." :button (:toggle . gdb-many-windows))) (define-key menu [gdb-restore-windows] '(menu-item "Restore Window Layout" gdb-restore-windows @@ -4029,7 +4029,7 @@ ;; Locals buffer. ;; -;; uses "-stack-list-locals --simple-values". Needs GDB 6.1 onwards. +;; uses "-stack-list-locals --simple-values". Needs GDB 6.1 onwards. (gdb-set-buffer-rules 'gdb-locals-buffer 'gdb-locals-buffer-name 'gdb-locals-mode)
--- a/lisp/progmodes/idlw-help.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/progmodes/idlw-help.el Sat Jan 02 02:05:44 2010 +0100 @@ -41,7 +41,7 @@ ;;; Code: (defvar idlwave-help-browse-url-available t - "Whether browse-url is available") + "Whether browse-url is available.") (require 'browse-url) @@ -58,9 +58,9 @@ (if idlwave-html-help-pre-v6 "#" "#wp")) (defcustom idlwave-html-system-help-location "help/online_help/" - "The directory, relative to idlwave-system-directory, where the idl + "The directory, relative to `idlwave-system-directory', where the IDL HTML help files live, for IDL 6.2 and later. This location, if found, -is used in preference to the old idlwave-html-help-location." +is used in preference to the old `idlwave-html-help-location'." :group 'idlwave-online-help :type 'directory) @@ -69,7 +69,7 @@ nil "/usr/local/etc/") "The directory where the idl_html_help/ dir lives. Obsolete for IDL -6.2 or later (see idlwave-html-system-help-location)." +6.2 or later (see `idlwave-html-system-help-location')." :group 'idlwave-online-help :type 'directory) @@ -82,13 +82,13 @@ :type 'boolean) (defcustom idlwave-help-browser-function browse-url-browser-function - "Function to use to display html help. + "Function to use to display HTML help. Defaults to `browse-url-browser-function', which see." :group 'idlwave-online-help :type 'function) (defcustom idlwave-help-browser-generic-program browse-url-generic-program - "Program to run if using browse-url-generic-program." + "Program to run if using `browse-url-generic-program'." :group 'idlwave-online-help :type 'string) @@ -97,7 +97,7 @@ (defcustom idlwave-help-browser-generic-args (if (boundp 'browse-url-generic-args) browse-url-generic-args "") - "Program args to use if using browse-url-generic-program." + "Program args to use if using `browse-url-generic-program'." :group 'idlwave-online-help :type 'string) @@ -112,7 +112,7 @@ :type 'boolean) (defvar idlwave-help-directory "" - "Obsolete variable. See idlwave-html-help-location.") + "Obsolete variable. See `idlwave-html-help-location'.") (defcustom idlwave-help-use-dedicated-frame t "*Non-nil means, use a separate frame for Online Help if possible." @@ -210,10 +210,10 @@ "The default width of the help frame.") (defvar idlwave-html-help-is-available nil - "Is the system online help text avaiable?") + "Is the system online help text available?") (defvar idlwave-help-mode-line-indicator "" - "Used for the special mode line in the idlwave-help-mode.") + "Used for the special mode line in the `idlwave-help-mode'.") (defvar idlwave-help-window-configuration nil) (defvar idlwave-help-special-topic-words nil) ; defined by get_rinfo @@ -221,7 +221,7 @@ ;; Define the key bindings for the Help application (defvar idlwave-help-mode-map (make-sparse-keymap) - "The keymap used in idlwave-help-mode.") + "The keymap used in `idlwave-help-mode'.") (define-key idlwave-help-mode-map "q" 'idlwave-help-quit) (define-key idlwave-help-mode-map "w" 'widen) @@ -303,7 +303,7 @@ Fontification: [F]ontify the buffer like source code Jump: [h] to function doclib header [H] to file doclib header - [.] back and forward between header and definition + [.] back and forth between header and definition Here are all keybindings. \\{idlwave-help-mode-map}" @@ -367,7 +367,7 @@ (defvar idlwave-experimental) (defvar idlwave-last-context-help-pos) (defun idlwave-do-context-help (&optional arg) - "Wrapper around the call to idlwave-context-help1. + "Wrapper around the call to `idlwave-do-context-help1'. It collects and prints the diagnostics messages." (let ((marker (list (current-buffer) (point))) (idlwave-help-diagnostics nil)) @@ -766,7 +766,7 @@ "Display HTML or other special help on a certain topic. Either loads an HTML link, if LINK is non-nil, or gets special-help on the optional arguments, if any special help is defined. If LINK is -`t', first look up the optional arguments in the routine info list to +t, first look up the optional arguments in the routine info list to see if a link is set for it. Try extra help functions if necessary." ;; Lookup link (if (eq link t) @@ -817,7 +817,7 @@ (select-window cw))) (defun idlwave-help-html-link (link) - "Get html help on a given LINK." + "Get HTML help on a given LINK." (let ((browse-url-browser-function idlwave-help-browser-function) (help-loc (idlwave-html-help-location)) (browse-url-generic-program idlwave-help-browser-generic-program) @@ -847,14 +847,14 @@ (defvar idlwave-current-tags-buffer) (defvar idlwave-current-tags-class) (defun idlwave-help-with-source (name type class keyword) - "Provide help for routines not documented in the IDL manuals. Works -by loading the routine source file into the help buffer. Depending on -the value of `idlwave-help-source-try-header', it attempts to show the -routine definition or the header description. If -`idlwave-help-do-class-struct-tag' is non-nil, keyword is a tag to -show help on from the class definition structure. If -`idlwave-help-do-struct-tag' is non-nil, show help from the matching -structure tag definition. + "Provide help for routines not documented in the IDL manuals. +Works by loading the routine source file into the help buffer. +Depending on the value of `idlwave-help-source-try-header', it +attempts to show the routine definition or the header description. +If `idlwave-help-do-class-struct-tag' is non-nil, keyword is a tag +to show help on from the class definition structure. +If `idlwave-help-do-struct-tag' is non-nil, show help from the +matching structure tag definition. This function can be used as `idlwave-extra-help-function'." (let* ((class-struct-tag idlwave-help-do-class-struct-tag) @@ -953,7 +953,8 @@ (defun idlwave-help-find-routine-definition (name type class keyword) "Find the definition of routine CLASS::NAME in current buffer. -KEYWORD is ignored. Returns the point of match if successful, nil otherwise." +Returns the point of match if successful, nil otherwise. +KEYWORD is ignored." (save-excursion (goto-char (point-max)) (if (re-search-backward @@ -1199,7 +1200,7 @@ "(help location unknown)"))) (defun idlwave-help-show-help-frame () - "Show the help frame, creating it if necessary" + "Show the help frame, creating it if necessary." ;; Use a special frame for this (unless (frame-live-p idlwave-help-frame) (setq idlwave-help-frame @@ -1254,7 +1255,7 @@ (if (memq system-type '(ms-dos windows-nt)) "bin/bin.x86/idl_assistant.exe" "bin/idl_assistant") - "The command, rooted at idlwave-system-directory, which invokes the + "The command, rooted at `idlwave-system-directory', which invokes the IDL assistant.") (defun idlwave-help-assistant-available () @@ -1293,7 +1294,7 @@ (unless (accept-process-output idlwave-help-assistant-process 15) (error "Failed binding IDL_ASSISTANT socket")) (if (not port) - (error "Unable to open IDL_ASSISTANT.") + (error "Unable to open IDL_ASSISTANT") (set-process-filter idlwave-help-assistant-process nil) (setq idlwave-help-assistant-socket (open-network-stream "IDL_ASSISTANT_SOCK"
--- a/lisp/progmodes/octave-mod.el Sat Jan 02 02:03:48 2010 +0100 +++ b/lisp/progmodes/octave-mod.el Sat Jan 02 02:05:44 2010 +0100 @@ -410,7 +410,7 @@ This mode makes it easier to write Octave code by helping with indentation, doing some of the typing for you (with Abbrev mode) and by -showing keywords, comments, strings, etc.. in different faces (with +showing keywords, comments, strings, etc. in different faces (with Font Lock mode on terminals that support it). Octave itself is a high-level language, primarily intended for numerical @@ -1260,7 +1260,7 @@ (defun octave-electric-semi () "Insert a semicolon in Octave mode. Maybe expand abbrevs and blink matching block open keywords. -Reindent the line of `octave-auto-indent' is non-nil. +Reindent the line if `octave-auto-indent' is non-nil. Insert a newline if `octave-auto-newline' is non-nil." (interactive) (if (not (octave-not-in-string-or-comment-p)) @@ -1277,7 +1277,7 @@ (defun octave-electric-space () "Insert a space in Octave mode. Maybe expand abbrevs and blink matching block open keywords. -Reindent the line of `octave-auto-indent' is non-nil." +Reindent the line if `octave-auto-indent' is non-nil." (interactive) (setq last-command-event ? ) (if (and octave-auto-indent