From dada060d9f65ce57fca99bef6e5a69ee88e126cf Mon Sep 17 00:00:00 2001 From: Juanma Barranquero Date: Fri, 21 Mar 2014 02:12:57 +0100 Subject: [PATCH] lisp/*.el: Fix typos. * lisp/align.el (align-regexp): Remove superfluous backslash. * lisp/ffap.el (ffap-ftp-default-user, ffap-url-regexp) (ffap-pass-wildcards-to-dired, dired-at-point-require-prefix) (ffap-rfc-path, ffap-ftp-sans-slash-regexp, ffap-menu-regexp): Fix docstring typos. (ffap-next): Use C-u in docstring. (ffap-machine-p, ffap-list-env, ffap-alist, ffap-alist) (ffap-string-at-point-mode-alist, ffap-menu, ffap-menu-ask): Remove superfluous backslashes. (ffap-string-at-point): Reflow docstring. * lisp/server.el (server-host): Reflow docstring. (server-unload-function): Fix docstring typo. (server-eval-at): Remove superfluous backslash. * lisp/skeleton.el (skeleton-insert): Remove superfluous backslash. (skeleton-insert): Doc fix. (skeleton-insert): Reflow docstring. * lisp/term/tty-colors.el (tty-color-alist, tty-modify-color-alist) (tty-color-approximate, tty-color-by-index, tty-color-values) (tty-color-desc): Remove superfluous backslashes. --- lisp/ChangeLog | 26 ++++++++++++++++++++++++++ lisp/align.el | 2 +- lisp/ffap.el | 40 ++++++++++++++++++++-------------------- lisp/server.el | 12 ++++++------ lisp/skeleton.el | 20 ++++++++++---------- lisp/term/tty-colors.el | 14 +++++++------- 6 files changed, 70 insertions(+), 44 deletions(-) diff --git a/lisp/ChangeLog b/lisp/ChangeLog index 857c086790e..8a9acd99423 100644 --- a/lisp/ChangeLog +++ b/lisp/ChangeLog @@ -1,3 +1,29 @@ +2014-03-21 Juanma Barranquero + + * align.el (align-regexp): Remove superfluous backslash. + + * ffap.el (ffap-ftp-default-user, ffap-url-regexp) + (ffap-pass-wildcards-to-dired, dired-at-point-require-prefix) + (ffap-rfc-path, ffap-ftp-sans-slash-regexp, ffap-menu-regexp): + Fix docstring typos. + (ffap-next): Use C-u in docstring. + (ffap-machine-p, ffap-list-env, ffap-alist, ffap-alist) + (ffap-string-at-point-mode-alist, ffap-menu, ffap-menu-ask): + Remove superfluous backslashes. + (ffap-string-at-point): Reflow docstring. + + * server.el (server-host): Reflow docstring. + (server-unload-function): Fix docstring typo. + (server-eval-at): Remove superfluous backslash. + + * skeleton.el (skeleton-insert): Remove superfluous backslash. + (skeleton-insert): Doc fix. + (skeleton-insert): Reflow docstring. + + * term/tty-colors.el (tty-color-alist, tty-modify-color-alist) + (tty-color-approximate, tty-color-by-index, tty-color-values) + (tty-color-desc): Remove superfluous backslashes. + 2014-03-20 Stefan Monnier * electric.el (electric-newline-and-maybe-indent): New command. diff --git a/lisp/align.el b/lisp/align.el index 1efc6e6505b..9038adf624c 100644 --- a/lisp/align.el +++ b/lisp/align.el @@ -937,7 +937,7 @@ throughout the line. See `align-rules-list' for more information about these options. The non-interactive form of the previous example would look something like: - \(align-regexp (point-min) (point-max) \"\\\\(\\\\s-*\\\\)(\") + (align-regexp (point-min) (point-max) \"\\\\(\\\\s-*\\\\)(\") This function is a nothing more than a small wrapper that helps you construct a rule to pass to `align-region', which does the real work." diff --git a/lisp/ffap.el b/lisp/ffap.el index 7051273a681..119e0ad3078 100644 --- a/lisp/ffap.el +++ b/lisp/ffap.el @@ -164,9 +164,9 @@ schemes (e.g. \"ftp\"); in that case, only convert those URLs." :version "24.3") (defcustom ffap-ftp-default-user "anonymous" - "User name in ftp file names generated by `ffap-host-to-path'. + "User name in FTP file names generated by `ffap-host-to-path'. Note this name may be omitted if it equals the default -\(either `efs-default-user' or `ange-ftp-default-user'\)." +\(either `efs-default-user' or `ange-ftp-default-user')." :type 'string :group 'ffap) @@ -185,7 +185,7 @@ Note this name may be omitted if it equals the default "\\|" "\\(ftp\\|https?\\|telnet\\|gopher\\|www\\|wais\\)://" ; needs host "\\)") - "Regexp matching the beginning of a URI, for FFAP. + "Regexp matching the beginning of a URI, for ffap. If the value is nil, disable URL-matching features in ffap.") (defcustom ffap-foo-at-bar-prefix "mailto" @@ -228,7 +228,7 @@ it passes it on to `dired'." :group 'ffap) (defcustom ffap-pass-wildcards-to-dired nil - "If non-nil, pass filenames matching `ffap-dired-wildcards' to dired." + "If non-nil, pass filenames matching `ffap-dired-wildcards' to Dired." :type 'boolean :group 'ffap) @@ -291,8 +291,8 @@ For a fancy alternative, get `ffap-url.el'." (defcustom dired-at-point-require-prefix nil "If non-nil, reverse the prefix argument to `dired-at-point'. -This is nil so neophytes notice FFAP. Experts may prefer to -disable FFAP most of the time." +This is nil so neophytes notice ffap. Experts may prefer to +disable ffap most of the time." :type 'boolean :group 'ffap :version "20.3") @@ -343,7 +343,7 @@ Only considers strings that match `ffap-next-regexp'." "Search buffer for next file or URL, and run ffap. Optional argument BACK says to search backwards. Optional argument WRAP says to try wrapping around if necessary. -Interactively: use a single prefix to search backwards, +Interactively: use a single prefix \\[universal-argument] to search backwards, double prefix to wrap forward, triple to wrap backwards. Actual search is done by the function `ffap-next-guess'." (interactive @@ -413,7 +413,7 @@ See `mail-extr.el' for the known domains." Depending on the domain (none, known, or unknown), follow the strategy named by the variable `ffap-machine-p-local', `ffap-machine-p-known', or `ffap-machine-p-unknown'. Pinging uses `open-network-stream'. -Optional SERVICE specifies the port used \(default \"discard\"\). +Optional SERVICE specifies the port used (default \"discard\"). Optional QUIET flag suppresses the \"Pinging...\" message. Optional STRATEGY overrides the three variables above. Returned values: @@ -642,7 +642,7 @@ Looks at `ffap-ftp-default-user', returns \"\" for \"localhost\"." (defun ffap-list-env (env &optional empty) "Return a list of strings parsed from environment variable ENV. -Optional EMPTY is the default list if \(getenv ENV\) is undefined, and +Optional EMPTY is the default list if (getenv ENV) is undefined, and also is substituted for the first empty-string component, if there is one. Uses `path-separator' to separate the path into substrings." ;; We cannot use parse-colon-path (files.el), since it kills @@ -787,12 +787,12 @@ This uses `ffap-file-exists-string', which may try adding suffixes from . ffap-rfc) ; "100% RFC2100 compliant" (dired-mode . ffap-dired) ; maybe in a subdirectory ) - "Alist of \(KEY . FUNCTION\) pairs parsed by `ffap-file-at-point'. + "Alist of (KEY . FUNCTION) pairs parsed by `ffap-file-at-point'. If string NAME at point (maybe \"\") is not a file or URL, these pairs specify actions to try creating such a string. A pair matches if either KEY is a symbol, and it equals `major-mode', or KEY is a string, it should match NAME as a regexp. -On a match, \(FUNCTION NAME\) is called and should return a file, an +On a match, (FUNCTION NAME) is called and should return a file, an URL, or nil. If nil, search the alist for further matches.") (put 'ffap-alist 'risky-local-variable t) @@ -980,7 +980,7 @@ If t, `ffap-tex-init' will initialize this when needed.") (defcustom ffap-rfc-path (concat (ffap-host-to-filename "ftp.rfc-editor.org") "/in-notes/rfc%s.txt") "A `format' string making a filename for RFC documents. -This can be an ange-ftp or tramp remote filename to download, or +This can be an ange-ftp or Tramp remote filename to download, or a local filename if you have full set of RFCs locally. See also `ffap-rfc-directories'." :type 'string @@ -1018,8 +1018,8 @@ If a given RFC isn't in these then `ffap-rfc-path' is offered." ;; Mathematica paths: allow backquotes (math-mode ",-:$+<>@-Z_[:lower:]~`" "<" "@>;.,!?`:") ) - "Alist of \(MODE CHARS BEG END\), where MODE is a symbol, -possibly a major-mode name, or one of the symbol + "Alist of (MODE CHARS BEG END), where MODE is a symbol, +possibly a major-mode name, or one of the symbols `file', `url', `machine', and `nocolon'. Function `ffap-string-at-point' uses the data fields as follows: 1. find a maximal string of CHARS around point, @@ -1032,8 +1032,8 @@ Function `ffap-string-at-point' uses the data fields as follows: (defun ffap-string-at-point (&optional mode) "Return a string of characters from around point. -MODE (defaults to value of `major-mode') is a symbol used to look up string -syntax parameters in `ffap-string-at-point-mode-alist'. +MODE (defaults to value of `major-mode') is a symbol used to look up +string syntax parameters in `ffap-string-at-point-mode-alist'. If MODE is not found, we use `file' instead of MODE. If the region is active, return a string from the region. Sets the variable `ffap-string-at-point' and the variable @@ -1143,7 +1143,7 @@ The two subexpressions are the KEY and VALUE.") ;; Icky regexp avoids: default: 123: foo::bar cs:pub ;; It does match on: mic@cs: cs:/pub mathcs.emory.edu: (point at end) "\\`\\([^:@]+@[^:@]+:\\|[^@.:]+\\.[^@:]+:\\|[^:]+:[~/]\\)\\([^:]\\|\\'\\)") - "Strings matching this are coerced to ftp file names by ffap. + "Strings matching this are coerced to FTP file names by ffap. That is, ffap just prepends \"/\". Set to nil to disable.") (defun ffap-file-at-point () @@ -1445,7 +1445,7 @@ and the functions `ffap-file-at-point' and `ffap-url-at-point'." (defcustom ffap-menu-regexp nil "If non-nil, regexp overriding `ffap-next-regexp' in `ffap-menu'. Make this more restrictive for faster menu building. -For example, try \":/\" for URL (and some ftp) references." +For example, try \":/\" for URL (and some FTP) references." :type '(choice (const nil) regexp) :group 'ffap) @@ -1465,7 +1465,7 @@ These properties may be used to fontify the menu references.") "Put up a menu of files and URLs mentioned in this buffer. Then set mark, jump to choice, and try to fetch it. The menu is cached in `ffap-menu-alist', and rebuilt by `ffap-menu-rescan'. -The optional RESCAN argument \(a prefix, interactively\) forces +The optional RESCAN argument (a prefix, interactively) forces a rebuild. Searches with `ffap-menu-regexp'." (interactive "P") ;; (require 'imenu) -- no longer used, but roughly emulated @@ -1498,7 +1498,7 @@ a rebuild. Searches with `ffap-menu-regexp'." (defun ffap-menu-ask (title alist cont) "Prompt from a menu of choices, and then apply some action. -Arguments are TITLE, ALIST, and CONT \(a continuation function\). +Arguments are TITLE, ALIST, and CONT (a continuation function). This uses either a menu or the minibuffer depending on invocation. The TITLE string is used as either the prompt or menu title. Each ALIST entry looks like (STRING . DATA) and defines one choice. diff --git a/lisp/server.el b/lisp/server.el index a8e4444b999..0c645889d75 100644 --- a/lisp/server.el +++ b/lisp/server.el @@ -104,10 +104,10 @@ "The name or IP address to use as host address of the server process. If set, the server accepts remote connections; otherwise it is local. -DO NOT give this a non-nil value unless you know what you are -doing! On unsecured networks, accepting remote connections is -very dangerous, because server-client communication (including -session authentication) is not encrypted." +DO NOT give this a non-nil value unless you know what you are doing! +On unsecured networks, accepting remote connections is very dangerous, +because server-client communication (including session authentication) +is not encrypted." :group 'server :type '(choice (string :tag "Name or IP address") @@ -1634,7 +1634,7 @@ only these files will be asked to be saved." (define-key ctl-x-map "#" 'server-edit) (defun server-unload-function () - "Unload the server library." + "Unload the Server library." (server-mode -1) (substitute-key-definition 'server-edit nil ctl-x-map) (save-current-buffer @@ -1648,7 +1648,7 @@ only these files will be asked to be saved." "Contact the Emacs server named SERVER and evaluate FORM there. Returns the result of the evaluation, or signals an error if it cannot contact the specified server. For example: - \(server-eval-at \"server\" '(emacs-pid)) + (server-eval-at \"server\" '(emacs-pid)) returns the process ID of the Emacs instance running \"server\"." (let* ((server-dir (if server-use-tcp server-auth-dir server-socket-dir)) (server-file (expand-file-name server server-dir)) diff --git a/lisp/skeleton.el b/lisp/skeleton.el index 767f0b3490b..21f00d16c82 100644 --- a/lisp/skeleton.el +++ b/lisp/skeleton.el @@ -183,7 +183,7 @@ of `str' whereas the skeleton's interactor is then ignored." With optional second argument REGIONS, wrap first interesting point \(`_') in skeleton around next REGIONS words, if REGIONS is positive. If REGIONS is negative, wrap REGIONS preceding interregions into first -REGIONS interesting positions \(successive `_'s) in skeleton. +REGIONS interesting positions (successive `_'s) in skeleton. An interregion is the stretch of text between two contiguous marked points. If you marked A B C [] (where [] is the cursor) in @@ -208,21 +208,21 @@ If ELEMENT is a string or a character it gets inserted (see also @ add position to `skeleton-positions' & do next ELEMENT if previous moved point | do next ELEMENT if previous didn't move point - -num delete num preceding characters (see `skeleton-untabify') + -NUM delete NUM preceding characters (see `skeleton-untabify') resume: skipped, continue here if quit is signaled nil skipped After termination, point will be positioned at the last occurrence of - or at the first occurrence of _ or at the end of the inserted text. -Further elements can be defined via `skeleton-further-elements'. ELEMENT may -itself be a SKELETON with an INTERACTOR. The user is prompted repeatedly for -different inputs. The SKELETON is processed as often as the user enters a -non-empty string. \\[keyboard-quit] terminates skeleton insertion, but -continues after `resume:' and positions at `_' if any. If INTERACTOR in such -a subskeleton is a prompt-string which contains a \".. %s ..\" it is -formatted with `skeleton-subprompt'. Such an INTERACTOR may also be a list of -strings with the subskeleton being repeated once for each string. +Further elements can be defined via `skeleton-further-elements'. +ELEMENT may itself be a SKELETON with an INTERACTOR. The user is prompted +repeatedly for different inputs. The SKELETON is processed as often as +the user enters a non-empty string. \\[keyboard-quit] terminates skeleton insertion, but +continues after `resume:' and positions at `_' if any. If INTERACTOR in +such a subskeleton is a prompt-string which contains a \".. %s ..\" it is +formatted with `skeleton-subprompt'. Such an INTERACTOR may also be a list +of strings with the subskeleton being repeated once for each string. Quoted Lisp expressions are evaluated for their side-effects. Other Lisp expressions are evaluated and the value treated as above. diff --git a/lisp/term/tty-colors.el b/lisp/term/tty-colors.el index 60be0a40f58..7e53a98d02a 100644 --- a/lisp/term/tty-colors.el +++ b/lisp/term/tty-colors.el @@ -771,7 +771,7 @@ "Return an alist of colors supported by FRAME's terminal. FRAME defaults to the selected frame. Each element of the returned alist is of the form: - \(NAME INDEX R G B\) + (NAME INDEX R G B) where NAME is the name of the color, a string; INDEX is the index of this color to be sent to the terminal driver when the color should be displayed; it is typically a small integer; @@ -785,10 +785,10 @@ color." (defun tty-modify-color-alist (elt &optional frame) "Put the association ELT into the alist of terminal colors for FRAME. -ELT should be of the form \(NAME INDEX R G B\) (see `tty-color-alist' +ELT should be of the form (NAME INDEX R G B) (see `tty-color-alist' for details). If the association for NAME already exists in the color alist, it is -modified to specify \(INDEX R G B\) as its cdr. Otherwise, ELT is +modified to specify (INDEX R G B) as its cdr. Otherwise, ELT is appended to the end of the color alist. If FRAME is unspecified or nil, it defaults to the selected frame. Value is the modified color alist for FRAME." @@ -856,7 +856,7 @@ of gray, thus the name." (defun tty-color-approximate (rgb &optional frame) "Find the color in `tty-color-alist' that best approximates RGB. -Value is a list of the form \(NAME INDEX R G B\). +Value is a list of the form (NAME INDEX R G B). The argument RGB should be an rgb value, that is, a list of three integers in the 0..65535 range. FRAME defaults to the selected frame." @@ -981,7 +981,7 @@ If FRAME is unspecified or nil, it defaults to the selected frame." "Given a numeric index of a tty color, return its description. FRAME, if unspecified or nil, defaults to the selected frame. -Value is a list of the form \(NAME INDEX R G B\)." +Value is a list of the form (NAME INDEX R G B)." (and idx (let ((colors (tty-color-alist frame)) desc found) @@ -997,14 +997,14 @@ Value is a list of the form \(NAME INDEX R G B\)." If COLOR is not directly supported by the display, return the RGB values for a supported color that is its best approximation. -The value is a list of integer RGB values--\(RED GREEN BLUE\). +The value is a list of integer RGB values--(RED GREEN BLUE). These values range from 0 to 65535; white is (65535 65535 65535). If FRAME is omitted or nil, use the selected frame." (cddr (tty-color-desc color frame))) (defun tty-color-desc (color &optional frame) "Return the description of the color COLOR for a character terminal. -Value is a list of the form \(NAME INDEX R G B\). The returned NAME or +Value is a list of the form (NAME INDEX R G B). The returned NAME or RGB value may not be the same as the argument COLOR, because the latter might need to be approximated if it is not supported directly." (and (stringp color) -- 2.39.2