Commit 760701eb authored by Paul Eggert's avatar Paul Eggert
Browse files

Don't quote symbols 'like-this' in docstrings etc.

* admin/unidata/uvs.el (uvs-insert-fields-as-bytes):
* lisp/allout-widgets.el (allout-widgets-count-buttons-in-region):
* lisp/allout.el (allout-add-resumptions, allout-mode):
* lisp/calculator.el (calculator-operators):
* lisp/cedet/data-debug.el (dd-propertize):
* lisp/cedet/ede/proj-prog.el (ede-proj-target-makefile-program):
* lisp/cedet/semantic/analyze/debug.el:
(semantic-analyzer-debug-global-miss-text):
* lisp/cedet/semantic/lex-spp.el:
(semantic-lex-spp-replace-or-symbol-or-keyword):
* lisp/cedet/semantic/symref.el:
(semantic-symref-cleanup-recent-buffers-fcn):
* lisp/cedet/semantic/tag.el (semantic-tag-class):
* lisp/cedet/srecode/el.el (srecode-semantic-handle-:el-custom):
* lisp/gnus/nnmairix.el (nnmairix-propagate-marks-upon-close):
* lisp/gnus/pop3.el (pop3-authentication-scheme):
* lisp/help-fns.el (describe-function-orig-buffer):
* lisp/imenu.el (imenu--history-list):
* lisp/mail/feedmail.el (feedmail-confirm-outgoing)
(feedmail-display-full-frame, feedmail-deduce-bcc-where)
(feedmail-queue-default-file-slug)
(feedmail-queue-buffer-file-name):
* lisp/net/mairix.el (mairix-searches-mode-map):
* lisp/net/newst-backend.el (newsticker-retrieval-method)
(newsticker-auto-mark-filter-list):
* lisp/obsolete/vi.el (vi-mode):
* lisp/progmodes/cc-engine.el (c-literal-type):
* lisp/progmodes/cpp.el (cpp-face):
* lisp/progmodes/ebrowse.el (ebrowse-electric-list-looper):
* lisp/progmodes/elisp-mode.el (elisp--xref-make-xref):
* lisp/progmodes/pascal.el (pascal-auto-lineup):
* lisp/progmodes/prog-mode.el (prog-widen):
* lisp/progmodes/verilog-mode.el (verilog-regexp-words)
(verilog-auto-lineup, verilog-auto-reset-widths)
(verilog-auto-arg-format, verilog-auto-inst-template-numbers):
* lisp/textmodes/flyspell.el (flyspell-maybe-correct-transposition)
(flyspell-maybe-correct-doubling):
* lisp/textmodes/table.el (table-justify, table-justify-cell)
(table-justify-row, table-justify-column, table-insert-sequence)
(table--justify-cell-contents):
* lisp/url/url-auth.el (url-get-authentication):
* lisp/window.el (display-buffer-record-window):
* lisp/xml.el (xml-parse-file, xml-parse-region):
* src/gfilenotify.c (Fgfile_add_watch):
Don't quote symbols with apostrophes in doc strings.
Use asymmetric quotes instead.
* lisp/cedet/semantic/complete.el (semantic-displayor-show-request):
Likewise for symbol in diagnostic.
* lisp/image.el (image-extension-data):
* lisp/register.el (frame-configuration-to-register):
* src/buffer.c (syms_of_buffer):
Remove bogus apostrophes after symbols.
* lisp/thumbs.el (thumbs-conversion-program):
Quote Lisp string values using double-quotes, not apostrophes.
parent daf390b5
......@@ -114,7 +114,7 @@ The most significant byte comes first."
"Insert VALUES for FIELDS as a sequence of bytes to the current buffer.
VALUES and FIELDS are lists of integers and field symbols,
respectively. Byte length of each value is determined by the
'uvs-field-size' property of the corresponding field."
`uvs-field-size' property of the corresponding field."
(while fields
(let ((field (car fields))
(value (car values)))
......
......@@ -2372,7 +2372,7 @@ The elements of LIST are not copied, just the list structure itself."
(car list)))
;;;_ . allout-widgets-count-buttons-in-region (start end)
(defun allout-widgets-count-buttons-in-region (start end)
"Debugging/diagnostic tool - count overlays with 'button' property in region."
"Debugging/diagnostic tool - count overlays with `button' property in region."
(interactive "r")
(setq start (or start (point-min))
end (or end (point-max)))
......
......@@ -1330,11 +1330,11 @@ cdr is the new value: '(some-var some-value)'. The pairs can actually be
triples, where the third element qualifies the disposition of the setting,
as described further below.
If the optional third element is the symbol 'extend, then the new value
If the optional third element is the symbol `extend', then the new value
created by `cons'ing the second element of the pair onto the front of the
existing value.
If the optional third element is the symbol 'append, then the new value is
If the optional third element is the symbol `append', then the new value is
extended from the existing one by `append'ing a list containing the second
element of the pair onto the end of the existing value.
......@@ -1838,7 +1838,7 @@ M-x outlineify-sticky Activate outline mode for current buffer,
buffer with name derived from derived from that
of current buffer -- \"*BUFFERNAME exposed*\".
\\[allout-flatten-exposed-to-buffer] `allout-flatten-exposed-to-buffer'
Like above 'copy-exposed', but convert topic
Like above `copy-exposed', but convert topic
prefixes to section.subsection... numeric
format.
\\[customize-variable] allout-auto-activation
......
......@@ -311,7 +311,7 @@ user-defined operators, use `calculator-user-operators' instead.")
9 (highest) (optional, defaults to 1);
It it possible have a unary prefix version of a binary operator if it
comes later in this list. If the list begins with the symbol 'nobind,
comes later in this list. If the list begins with the symbol `nobind',
then no key binding will take place -- this is only useful for
predefined keys.
......
......@@ -55,7 +55,7 @@
(defalias 'data-debug-overlay-p 'extentp)
(if (not (fboundp 'propertize))
(defun dd-propertize (string &rest properties)
"Mimic 'propertize' in from Emacs 23."
"Mimic `propertize' in from Emacs 23."
(add-text-properties 0 (length string) properties string)
string
)
......
......@@ -62,7 +62,7 @@ specified with ldlibs.")
"Libraries, such as \"m\" or \"Xt\" which this program depends on.
The linker flag \"-l\" is automatically prepended. Do not include a \"lib\"
prefix, or a \".so\" suffix.
Use the 'ldflags' slot to specify where in-project libraries might be.
Use the `ldflags' slot to specify where in-project libraries might be.
Note: Currently only used for Automake projects."
)
......
......@@ -512,7 +512,7 @@ Optional argument CLASSCONSTRAINT says to output to tags of that class."
)
(defun semantic-analyzer-debug-global-miss-text (name-in)
"Use 'princ' to show text describing not finding symbol NAME-IN.
"Use `princ' to show text describing not finding symbol NAME-IN.
NAME is the name of the unfound symbol."
(let ((name (cond ((stringp name-in)
name-in)
......
......@@ -1665,7 +1665,7 @@ Display mechanism using tooltip for a list of possible completions.")
(when (>= (oref obj typing-count) 5)
(oset obj mode 'standard)
(setq mode 'standard)
(message "Resetting inline-mode to 'standard'."))
(message "Resetting inline-mode to standard."))
(when (and (> numcompl max-tags)
(< (oref obj typing-count) 2))
;; Discretely hint at completion availability.
......
......@@ -919,7 +919,7 @@ STR occurs in the current buffer between BEG and END."
))
(define-lex-regex-analyzer semantic-lex-spp-replace-or-symbol-or-keyword
"Like 'semantic-lex-symbol-or-keyword' plus preprocessor macro replacement."
"Like `semantic-lex-symbol-or-keyword' plus preprocessor macro replacement."
"\\(\\sw\\|\\s_\\)+"
(let ((str (match-string 0))
(beg (match-beginning 0))
......
......@@ -337,7 +337,7 @@ Use the `semantic-symref-hit-tags' method to get this list.")
"List of buffers opened by `semantic-symref-result-get-tags'.")
(defun semantic-symref-cleanup-recent-buffers-fcn ()
"Hook function to be used in 'post-command-hook' to cleanup buffers.
"Hook function to be used in `post-command-hook' to cleanup buffers.
Buffers collected during symref can result in some files being
opened multiple times for one operation. This will keep buffers open
until the next command is executed."
......
......@@ -95,7 +95,7 @@ print statement."
(defsubst semantic-tag-class (tag)
"Return the class of TAG.
That is, the symbol 'variable, 'function, 'type, or other.
This is a symbol like `variable', `function', or `type'.
There is no limit to the symbols that may represent the class of a tag.
Each parser generates tags with classes defined by it.
......
......@@ -50,7 +50,7 @@ Adds the following:
(defun srecode-semantic-handle-:el-custom (dict)
"Add macros into the dictionary DICT based on the current Emacs Lisp file.
Adds the following:
GROUP - The 'defgroup' name we guess you want for variables.
GROUP - The `defgroup' name we guess you want for variables.
FACEGROUP - The `defgroup' name you might want for faces."
(require 'semantic/db-find)
(let ((groups (semanticdb-strip-find-results
......
......@@ -311,7 +311,7 @@ The default chooses the largest window in the current frame."
The default of this variable is t. If set to 'ask, the
user will be asked if the flags should be propagated when the
group is closed. If set to nil, the user will have to manually
call 'nnmairix-propagate-marks'."
call `nnmairix-propagate-marks'."
:version "23.1"
:type '(choice (const :tag "always" t)
(const :tag "ask" ask)
......
......@@ -82,7 +82,7 @@
(defcustom pop3-authentication-scheme 'pass
"*POP3 authentication scheme.
Defaults to `pass', for the standard USER/PASS authentication. The other
valid value is 'apop'."
valid value is `apop'."
:type '(choice (const :tag "Normal user/password" pass)
(const :tag "APOP" apop))
:version "22.1" ;; Oort Gnus
......
......@@ -44,7 +44,7 @@ The functions will receive the function name as argument.")
;; Functions
(defvar describe-function-orig-buffer nil
"Buffer that was current when 'describe-function' was invoked.
"Buffer that was current when `describe-function' was invoked.
Functions on 'help-fns-describe-function-functions' can use this
to get buffer-local values.")
......
......@@ -357,7 +357,7 @@ Optional DATA-P non-nil means SOURCE is a string containing image data."
(if (fboundp 'image-metadata) ; eg not --without-x
(define-obsolete-function-alias 'image-extension-data
'image-metadata' "24.1"))
'image-metadata "24.1"))
(define-obsolete-variable-alias
'image-library-alist
......
......@@ -476,7 +476,7 @@ element recalculates the buffer's index alist.")
(defvar imenu--history-list nil
;; Making this buffer local caused it not to work!
"History list for 'jump-to-function-in-buffer'.")
"History list for `jump-to-function-in-buffer'.")
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;
......
......@@ -399,10 +399,10 @@
"If non-nil, give a y-or-n confirmation prompt before sending mail.
This is done after the message is completely prepped, and you'll be
looking at the top of the message in a buffer when you get the prompt.
If set to the symbol 'queued, give the confirmation prompt only while
If set to the symbol `queued', give the confirmation prompt only while
running the queue (however, the prompt is always suppressed if you are
processing the queue via `feedmail-run-the-queue-no-prompts'). If set
to the symbol 'immediate, give the confirmation prompt only when
to the symbol `immediate', give the confirmation prompt only when
sending immediately. For any other non-nil value, prompt in both
cases. You can give a timeout for the prompt; see variable
`feedmail-confirm-outgoing-timeout'."
......@@ -418,9 +418,9 @@ cases. You can give a timeout for the prompt; see variable
If nil, the prepped message will be shown, for confirmation or
otherwise, in some window in the current frame without resizing
anything. That may or may not display enough of the message to
distinguish it from others. If set to the symbol 'queued, take
distinguish it from others. If set to the symbol queued, take
this action only when running the queue. If set to the symbol
'immediate, take this action only when sending immediately. For
immediate, take this action only when sending immediately. For
any other non-nil value, take the action in both cases. Even if
you're not confirming the sending of immediate or queued messages,
it can still be interesting to see a lot about them as they are
......@@ -471,9 +471,9 @@ Addresses for the message envelope are deduced by examining
appropriate address headers in the message. Generally, they will show
up in the list of deduced addresses in the order that the headers
happen to appear (duplicate addresses are eliminated in any case).
This variable can be set to the symbol 'first, in which case the
This variable can be set to the symbol first, in which case the
Bcc:/Resent-Bcc: addresses will appear at the beginning in the list;
or, it can be set to the symbol 'last, in which case they will appear
or, it can be set to the symbol last, in which case they will appear
at the end of the list.
Why should you care? Well, maybe you don't, and certainly the same
......@@ -484,7 +484,7 @@ addresses are not handled first, there can be substantial delays in
seeing the message again. Some configurations of sendmail, for example,
seem to try to deliver to each addressee at least once, immediately
and serially, so slow SMTP conversations can add up to a delay. There
is an option for either 'first or 'last because you might have a
is an option for either first or last because you might have a
delivery agent that processes the addresses backwards."
:group 'feedmail-headers
:type '(choice (const nil)
......@@ -1231,7 +1231,7 @@ If a string, it is used directly.
If a function, it is called with no arguments from the buffer containing the raw
text of the message. It must return a string (which may be empty).
If the symbol 'ask, you will be prompted for a string in the mini-buffer.
If the symbol `ask', you will be prompted for a string in the mini-buffer.
Filename completion is available so that you can inspect what's already been
used, but feedmail will do further manipulation on the string you return, so
it's not expected to be a complete filename."
......@@ -1301,27 +1301,27 @@ the fact in the messages buffer."
(defvar feedmail-queue-buffer-file-name nil
"If non-nil, has the value normally expected of 'buffer-file-name'.
"If non-nil, has the value normally expected of `buffer-file-name'.
You are not intended to set this to something in your configuration. Rather,
you might programmatically set it to something via a hook or function
advice or whatever. You might like to do this if you are using a mail
composition program that eventually uses sendmail.el's 'mail-send'
composition program that eventually uses sendmail.el's `mail-send'
function to process the message. If there is a filename associated
with the message buffer, 'mail-send' will ask you for confirmation.
with the message buffer, `mail-send' will ask you for confirmation.
There's no trivial way to avoid it. It's unwise to just set the value
of 'buffer-file-name' to nil because that will defeat feedmail's file
of `buffer-file-name' to nil because that will defeat feedmail's file
management features. Instead, arrange for this variable to be set to
the value of 'buffer-file-name' before setting that to nil. An easy way
to do that would be with defadvice on 'mail-send' \(undoing the
the value of `buffer-file-name' before setting that to nil. An easy way
to do that would be with defadvice on `mail-send' \(undoing the
assignments in a later advice\).
feedmail will pretend that 'buffer-file-name', if nil, has the value
assigned of 'feedmail-queue-buffer-file-name' and carry out its normal
feedmail will pretend that `buffer-file-name', if nil, has the value
assigned of `feedmail-queue-buffer-file-name' and carry out its normal
activities. feedmail does not restore the non-nil value of
'buffer-file-name'. For safe bookkeeping, the user should insure that
`buffer-file-name'. For safe bookkeeping, the user should insure that
feedmail-queue-buffer-file-name is restored to nil.
Example 'defadvice' for mail-send:
Example `defadvice' for mail-send:
(defadvice mail-send (before feedmail-mail-send-before-advice activate)
(setq feedmail-queue-buffer-file-name buffer-file-name)
......
......@@ -762,7 +762,7 @@ VALUES may contain values for editable fields from current article."
(define-key map [(d)] 'mairix-select-delete)
(define-key map [(s)] 'mairix-select-save)
map)
"'mairix-searches-mode' keymap.")
"`mairix-searches-mode' keymap.")
(defvar mairix-searches-mode-font-lock-keywords
'(("^\\([0-9]+\\)"
......
......@@ -235,7 +235,7 @@ which apply for this feed only, overriding the value of
'intern
"Method for retrieving news from the web, either `intern' or `extern'.
Default value `intern' uses Emacs' built-in asynchronous download
capabilities ('url-retrieve'). If set to `extern' the external
capabilities (`url-retrieve'). If set to `extern' the external
program wget is used, see `newsticker-wget-name'."
:type '(choice :tag "Method"
(const :tag "Intern" intern)
......@@ -332,9 +332,9 @@ deleted at the next retrieval."
This is an alist of the form (FEED-NAME PATTERN-LIST). I.e. each
element consists of a FEED-NAME a PATTERN-LIST. Each element of
the pattern-list has the form (AGE TITLE-OR-DESCRIPTION REGEXP).
AGE must be one of the symbols 'old or 'immortal.
TITLE-OR-DESCRIPTION must be on of the symbols 'title,
'description, or 'all. REGEXP is a regular expression, i.e. a
AGE must be one of the symbols `old' or `immortal'.
TITLE-OR-DESCRIPTION must be one of the symbols `title',
`description', or `all'. REGEXP is a regular expression, i.e., a
string.
This filter is checked after a new headline has been retrieved.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment