diff options
author | Paul Eggert <eggert@cs.ucla.edu> | 2015-11-17 15:28:50 -0800 |
---|---|---|
committer | Paul Eggert <eggert@cs.ucla.edu> | 2015-11-17 15:29:35 -0800 |
commit | ac16149ba470ae8a625d42a61adbb6e84254c675 (patch) | |
tree | 9575cf0f1c5139a1943f9a18dd444ddc46983aa9 /lisp/net | |
parent | abf673af29ba2a2e0001ebd1db183377724f0cc4 (diff) | |
download | emacs-ac16149ba470ae8a625d42a61adbb6e84254c675.tar.gz |
Fix docstring quoting problems with ‘ '’
Problem reported by Artur Malabarba in:
http://lists.gnu.org/archive/html/emacs-devel/2015-11/msg01513.html
Most of these fixes are to documentation; many involve fixing
longstanding quoting glitches that are independent of the
recent substitute-command-keys changes. The changes to code are:
* lisp/cedet/mode-local.el (mode-local-augment-function-help)
(describe-mode-local-overload):
Substitute docstrings before displaying them.
* lisp/emacs-lisp/cl-macs.el (cl--transform-lambda):
Quote the generated docstring for later substitution.
Diffstat (limited to 'lisp/net')
-rw-r--r-- | lisp/net/ange-ftp.el | 2 | ||||
-rw-r--r-- | lisp/net/eww.el | 2 | ||||
-rw-r--r-- | lisp/net/imap.el | 6 | ||||
-rw-r--r-- | lisp/net/mairix.el | 2 | ||||
-rw-r--r-- | lisp/net/newst-backend.el | 10 | ||||
-rw-r--r-- | lisp/net/newst-plainview.el | 12 | ||||
-rw-r--r-- | lisp/net/rcirc.el | 2 | ||||
-rw-r--r-- | lisp/net/soap-client.el | 4 | ||||
-rw-r--r-- | lisp/net/tramp.el | 4 |
9 files changed, 22 insertions, 22 deletions
diff --git a/lisp/net/ange-ftp.el b/lisp/net/ange-ftp.el index 4f7fa3b8f39..7fbf7f3650f 100644 --- a/lisp/net/ange-ftp.el +++ b/lisp/net/ange-ftp.el @@ -3863,7 +3863,7 @@ If VERBOSE-P is non-nil, print progress report in the echo area. FILES is a list of files to copy in the form (from-file to-file ok-if-already-exists keep-date) E.g., - (ange-ftp-copy-files-async t nil t '((\"a\" \"b\" t t) (\"c\" \"d\" t t)))" + (ange-ftp-copy-files-async t nil t \\='((\"a\" \"b\" t t) (\"c\" \"d\" t t)))" (unless okay-p (error "%s: %s" 'ange-ftp-copy-files-async line)) (if files (let* ((ff (car files)) diff --git a/lisp/net/eww.el b/lisp/net/eww.el index 5748e88bbca..cd659d0840e 100644 --- a/lisp/net/eww.el +++ b/lisp/net/eww.el @@ -93,7 +93,7 @@ desktop. Otherwise, such entries will be retained." (defcustom eww-restore-desktop nil "How to restore EWW buffers on `desktop-restore'. -If t or 'auto, the buffers will be reloaded automatically. +If t or `auto', the buffers will be reloaded automatically. If nil, buffers will require manual reload, and will contain the text specified in `eww-restore-reload-prompt' instead of the actual Web page contents." diff --git a/lisp/net/imap.el b/lisp/net/imap.el index b559ff65908..33eb3e43836 100644 --- a/lisp/net/imap.el +++ b/lisp/net/imap.el @@ -453,7 +453,7 @@ second the status (OK, NO, BAD etc) of the command.") When non-nil, use an alternative UIDS form. Enabling appears to be required for some servers (e.g., Microsoft Exchange 2007) -which otherwise would trigger a response 'BAD The specified +which otherwise would trigger a response `BAD The specified message set is invalid.'. We don't unconditionally use this form, since this is said to be significantly inefficient. @@ -1564,8 +1564,8 @@ returned, if ITEMS is a symbol only its value is returned." (defun imap-mailbox-status-asynch (mailbox items &optional buffer) "Send status item requests ITEMS on MAILBOX to server in BUFFER. ITEMS can be a symbol or a list of symbols, valid symbols are one of -the STATUS data items -- i.e. 'messages, 'recent, 'uidnext, 'uidvalidity -or 'unseen. The IMAP command tag is returned." +the STATUS data items -- i.e., `messages', `recent', `uidnext', `uidvalidity' +or `unseen'. The IMAP command tag is returned." (with-current-buffer (or buffer (current-buffer)) (imap-send-command (list "STATUS \"" (imap-utf7-encode mailbox) diff --git a/lisp/net/mairix.el b/lisp/net/mairix.el index a73b4dfa921..997e47b1ec2 100644 --- a/lisp/net/mairix.el +++ b/lisp/net/mairix.el @@ -211,7 +211,7 @@ nil for disabling this).") (defvar mairix-widget-other '(threads flags) "Other editable mairix commands when using customization widgets. -Currently there are 'threads and 'flags.") +Currently there are `threads' and `flags'.") ;;;; Internal variables diff --git a/lisp/net/newst-backend.el b/lisp/net/newst-backend.el index 072fd015b60..2bec11ee3a3 100644 --- a/lisp/net/newst-backend.el +++ b/lisp/net/newst-backend.el @@ -502,8 +502,8 @@ This is a list of the form where LABEL is a symbol. TITLE, DESCRIPTION, and LINK are strings. TIME is a time value as returned by `current-time'. -AGE is a symbol: 'new, 'old, 'immortal, and 'obsolete denote -ordinary news items, whereas 'feed denotes an item which is not a +AGE is a symbol: `new', `old', `immortal', and `obsolete' denote +ordinary news items, whereas `feed' denotes an item which is not a headline but describes the feed itself. INDEX denotes the original position of the item -- used for restoring the original order. PREFORMATTED-CONTENTS and PREFORMATTED-TITLE hold the @@ -1987,7 +1987,7 @@ Renders the HTML code in the region POS1 to POS2 using htmlr." (defun newsticker--cache-replace-age (data feed old-age new-age) "Mark all items in DATA in FEED which carry age OLD-AGE with NEW-AGE. -If FEED is 'any it applies to all feeds. If OLD-AGE is 'any, +If FEED is `any' it applies to all feeds. If OLD-AGE is `any', all marks are replaced by NEW-AGE. Removes all pre-formatted contents." (mapc (lambda (a-feed) (when (or (eq feed 'any) @@ -2038,7 +2038,7 @@ The properties which are checked are TITLE, DESC, LINK, AGE, and GUID. In general all properties must match in order to return a certain item, except for the following cases. -If AGE equals 'feed the TITLE, DESCription and LINK do not +If AGE equals `feed' the TITLE, DESCription and LINK do not matter. If DESC is nil it is ignored as well. If `newsticker-desc-comp-max' is non-nil, only the first `newsticker-desc-comp-max' characters of DESC are taken into @@ -2143,7 +2143,7 @@ which the item got." (defun newsticker--cache-remove (data feed-symbol age) "Remove all entries from DATA in the feed FEED-SYMBOL with AGE. -FEED-SYMBOL may be 'any. Entries from old feeds, which are no longer in +FEED-SYMBOL may be `any'. Entries from old feeds, which are no longer in `newsticker-url-list' or `newsticker-url-list-defaults', are removed as well." (let* ((pos data) diff --git a/lisp/net/newst-plainview.el b/lisp/net/newst-plainview.el index 0cb5d8c6a2f..b4e569078a9 100644 --- a/lisp/net/newst-plainview.el +++ b/lisp/net/newst-plainview.el @@ -228,7 +228,7 @@ Each function is called after one of `newsticker-next-item', `newsticker-next-new-item', `newsticker-previous-item', `newsticker-previous-new-item' has been called. -The default value 'newsticker--buffer-make-item-completely-visible +The default value `newsticker--buffer-make-item-completely-visible' assures that the current item is always completely visible." :type 'hook :options '(newsticker--buffer-make-item-completely-visible) @@ -240,7 +240,7 @@ assures that the current item is always completely visible." Each function is called after one of `newsticker-next-feed', and `newsticker-previous-feed' has been called. -The default value 'newsticker--buffer-make-item-completely-visible +The default value `newsticker--buffer-make-item-completely-visible' assures that the current feed is completely visible." :type 'hook :options '(newsticker--buffer-make-item-completely-visible) @@ -251,7 +251,7 @@ assures that the current feed is completely visible." "List of functions run after the newsticker buffer has been updated. Each function is called after `newsticker-buffer-update' has been called. -The default value `\\='newsticker-w3m-show-inline-images' loads inline +The default value `newsticker-w3m-show-inline-images' loads inline images." :type 'hook :group 'newsticker-plainview-hooks) @@ -263,7 +263,7 @@ Each function is called after `newsticker-toggle-auto-narrow-to-feed' or `newsticker-toggle-auto-narrow-to-item' has been called. -The default value `\\='newsticker-w3m-show-inline-images' loads inline +The default value `newsticker-w3m-show-inline-images' loads inline images." :type 'hook :group 'newsticker-plainview-hooks) @@ -1524,8 +1524,8 @@ Scans the buffer between START and END." (defun newsticker--buffer-set-invisibility (start end) "Add invisibility properties according to nt-type property. -Scans the buffer between START and END. Sets the 'invisible -property to '(<nt-type>-<nt-age> <nt-type> <nt-age>)." +Scans the buffer between START and END. Sets the `invisible' +property to (<nt-type>-<nt-age> <nt-type> <nt-age>)." (save-excursion ;; reset invisibility settings (put-text-property start end 'invisible nil) diff --git a/lisp/net/rcirc.el b/lisp/net/rcirc.el index d58f3ebd4ea..3539dcf91f4 100644 --- a/lisp/net/rcirc.el +++ b/lisp/net/rcirc.el @@ -320,7 +320,7 @@ Called with 5 arguments, PROCESS, SENDER, RESPONSE, TARGET and TEXT." (defcustom rcirc-decode-coding-system 'utf-8 "Coding system used to decode incoming irc messages. -Set to 'undecided if you want the encoding of the incoming +Set to `undecided' if you want the encoding of the incoming messages autodetected." :type 'coding-system :group 'rcirc) diff --git a/lisp/net/soap-client.el b/lisp/net/soap-client.el index 71d42459974..790084a4862 100644 --- a/lisp/net/soap-client.el +++ b/lisp/net/soap-client.el @@ -58,7 +58,7 @@ (require 'mm-decode) (defsubst soap-warning (message &rest args) - "Display a warning MESSAGE with ARGS, using the 'soap-client warning type." + "Display a warning MESSAGE with ARGS, using the `soap-client' warning type." ;; Do not use #'format-message, to support older Emacs versions. (display-warning 'soap-client (apply #'format message args) :warning)) @@ -562,7 +562,7 @@ fractional seconds, and the DST (daylight savings time) field is replaced with DATATYPE, a symbol representing the XSD primitive datatype. This symbol can be used to determine which fields apply and which don't when it's not already clear from context. -For example a datatype of 'time means the year, month and day +For example a datatype of `time' means the year, month and day fields should be ignored. This function will throw an error if DATE-TIME-STRING represents diff --git a/lisp/net/tramp.el b/lisp/net/tramp.el index 42a9e3d6710..40c3f368a9f 100644 --- a/lisp/net/tramp.el +++ b/lisp/net/tramp.el @@ -694,8 +694,8 @@ Useful for \"rsync\" like methods.") It can have the following values: - 'ftp -- Ange-FTP respective EFS like syntax (GNU Emacs default) - 'sep -- Syntax as defined for XEmacs." + `ftp' -- Ange-FTP respective EFS like syntax (GNU Emacs default) + `sep' -- Syntax as defined for XEmacs." :group 'tramp :version "24.4" :type `(choice (const :tag ,(if (featurep 'xemacs) "EFS" "Ange-FTP") ftp) |