Commit 9d35bb8d authored by Paul Eggert's avatar Paul Eggert
Browse files

Fix minor quoting problems in doc strings

These were glitches regardless of how or whether we tackle the
problem of grave accent in doc strings.
* lisp/calc/calc-aent.el (math-restore-placeholders):
* lisp/ido.el (ido-ignore-buffers, ido-ignore-files):
* lisp/leim/quail/cyrillic.el ("bulgarian-alt-phonetic"):
* lisp/leim/quail/hebrew.el ("hebrew-new")
("hebrew-biblical-sil"):
* lisp/leim/quail/thai.el ("thai-kesmanee"):
* lisp/progmodes/idlw-shell.el (idlwave-shell-file-name-chars):
Used curved quotes to avoid ambiguities like ‘`''’ in doc strings.
* lisp/calendar/calendar.el (calendar-month-abbrev-array):
* lisp/cedet/semantic/mru-bookmark.el (semantic-mrub-cache-flush-fcn):
* lisp/cedet/semantic/symref.el (semantic-symref-tool-baseclass):
* lisp/cedet/semantic/tag.el (semantic-tag-copy)
(semantic-tag-components):
* lisp/cedet/srecode/cpp.el (srecode-semantic-handle-:cpp):
* lisp/cedet/srecode/texi.el (srecode-texi-texify-docstring):
* lisp/emacs-lisp/byte-opt.el (byte-optimize-all-constp):
* lisp/emacs-lisp/checkdoc.el (checkdoc-message-text-engine):
* lisp/emacs-lisp/generator.el (iter-next):
* lisp/gnus/gnus-art.el (gnus-treat-strip-list-identifiers)
(gnus-article-mode-syntax-table):
* lisp/net/rlogin.el (rlogin-directory-tracking-mode):
* lisp/net/soap-client.el (soap-wsdl-get):
* lisp/net/telnet.el (telnet-mode):
* lisp/org/org-compat.el (org-number-sequence):
* lisp/org/org.el (org-remove-highlights-with-change)
(org-structure-template-alist):
* lisp/org/ox-html.el (org-html-link-org-files-as-html):
* lisp/play/handwrite.el (handwrite-10pt, handwrite-11pt)
(handwrite-12pt, handwrite-13pt):
* lisp/progmodes/f90.el (f90-mode, f90-abbrev-start):
* lisp/progmodes/idlwave.el (idlwave-mode, idlwave-check-abbrev):
* lisp/progmodes/verilog-mode.el (verilog-tool)
(verilog-string-replace-matches, verilog-preprocess)
(verilog-auto-insert-lisp, verilog-auto-insert-last):
* lisp/textmodes/makeinfo.el (makeinfo-options):
* src/font.c (Ffont_spec):
Fix minor quoting problems in doc strings, e.g., missing quote,
``x'' where `x' was meant, etc.
* lisp/erc/erc-backend.el (erc-process-sentinel-2):
Fix minor quoting problem in other string.
* lisp/leim/quail/ethiopic.el ("ethiopic"):
* lisp/term/tvi970.el (tvi970-set-keypad-mode):
Omit unnecessary quotes.
* lisp/faces.el (set-face-attribute, set-face-underline)
(set-face-inverse-video, x-create-frame-with-faces):
* lisp/gnus/gnus-group.el (gnus-group-nnimap-edit-acl):
* lisp/mail/supercite.el (sc-attribs-%@-addresses)
(sc-attribs-!-addresses, sc-attribs-<>-addresses):
* lisp/net/tramp.el (tramp-methods):
* lisp/recentf.el (recentf-show-file-shortcuts-flag):
* lisp/textmodes/artist.el (artist-ellipse-right-char)
(artist-ellipse-left-char, artist-vaporize-fuzziness)
(artist-spray-chars, artist-mode, artist-replace-string)
(artist-put-pixel, artist-text-see-thru):
* lisp/vc/ediff-util.el (ediff-submit-report):
* lisp/vc/log-edit.el (log-edit-changelog-full-paragraphs):
Use double-quotes rather than TeX markup in doc strings.
* lisp/skeleton.el (skeleton-pair-insert-maybe):
Reword to avoid the need for grave accent and apostrophe.
* lisp/xt-mouse.el (xterm-mouse-tracking-enable-sequence):
Don't use grave and acute accents to quote.
parent a0823e43
......@@ -1034,7 +1034,7 @@ in Calc algebraic input.")
(defun math-restore-placeholders (x)
"Replace placeholders by the proper characters in the symbol x.
This includes `#' for `_' and `'' for `%'.
This includes ‘#’ for ‘_’ and ‘'’ for ‘%’.
If the current Calc language does not use placeholders, return nil."
(if (or (memq calc-language calc-lang-allow-underscores)
(memq calc-language calc-lang-allow-percentsigns))
......
......@@ -2182,7 +2182,7 @@ in `calendar-month-name-array'. These abbreviations are used in
the calendar menu entries, and can also be used in the diary
file. Do not include a trailing `.' in the strings specified in
this variable, though you may use such in the diary file. By
default, each string is the first ``calendar-abbrev-length'
default, each string is the first `calendar-abbrev-length'
characters of the corresponding full name."
:group 'calendar
:set-after '(calendar-abbrev-length calendar-month-name-array)
......
......@@ -207,7 +207,7 @@ The resulting bookmark is then sorted within the ring."
)))
(defun semantic-mrub-cache-flush-fcn ()
"Function called in the `semantic-before-toplevel-cache-flush-hook`.
"Function called in the `semantic-before-toplevel-cache-flush-hook'.
Cause tags in the ring to become unlinked."
(let* ((ring (oref semantic-mru-bookmark-ring ring))
(len (ring-length ring))
......
......@@ -351,7 +351,7 @@ until the next command is executed."
(setq semantic-symref-recently-opened-buffers nil)
(remove-hook 'post-command-hook 'semantic-symref-cleanup-recent-buffers-fcn)
)
(cl-defmethod semantic-symref-result-get-tags ((result semantic-symref-result)
&optional open-buffers)
"Get the list of tags from the symref result RESULT.
......@@ -512,7 +512,7 @@ buffers that were opened."
(searchtype :initarg :searchtype
:type symbol
:documentation "The type of search to do.
Values could be `symbol, `regexp, 'tagname, or 'completion.")
Values could be 'symbol, 'regexp, 'tagname, or 'completion.")
(searchscope :initarg :searchscope
:type symbol
:documentation
......
......@@ -621,7 +621,7 @@ buffer, the originating buffer file name is kept in the `:filename'
property of the copied tag.
If KEEP-FILE is a string, and the originating buffer is NOT available,
then KEEP-FILE is stored on the `:filename' property.
This runs the tag hook `unlink-copy-hook`."
This runs the tag hook `unlink-copy-hook'."
;; Right now, TAG is a list.
(let ((copy (semantic-tag-clone tag name)))
......@@ -958,7 +958,7 @@ Return nil if TAG is not of class 'alias."
"Return a list of components for TAG.
A Component is a part of TAG which itself may be a TAG.
Examples include the elements of a structure in a
tag of class `type, or the list of arguments to a
tag of class 'type, or the list of arguments to a
tag of class 'function."
)
......
......@@ -84,7 +84,7 @@ HEADER - Shown section if in a header file."
;;;###autoload
(defun srecode-semantic-handle-:cpp (dict)
"Add macros into the dictionary DICT based on the current c file.
Calls `srecode-semantic-handle-:c.
Calls `srecode-semantic-handle-:c'.
Also adds the following:
- nothing -"
(srecode-semantic-handle-:c dict)
......
......@@ -241,11 +241,11 @@ This is to take advantage of TeXinfo's markup symbols."
For instances where CLASS is the class being referenced, do not Xref
that class.
`function' => @dfn{function}
`variable' => @code{variable}
`class' => @code{class} @xref{class}
`unknown' => @code{unknown}
\"text\" => ``text''
function => @dfn{function}
variable => @code{variable}
class => @code{class} @xref{class}
unknown => @code{unknown}
\" text \" => `` text ''
'quoteme => @code{quoteme}
non-nil => non-@code{nil}
t => @code{t}
......
......@@ -566,7 +566,7 @@
(cons fn args)))))))
(defun byte-optimize-all-constp (list)
"Non-nil if all elements of LIST satisfy `macroexp-const-p"
"Non-nil if all elements of LIST satisfy `macroexp-const-p'."
(let ((constant t))
(while (and list constant)
(unless (macroexp-const-p (car list))
......@@ -1225,7 +1225,7 @@
window-left-child window-left-column window-margins window-minibuffer-p
window-next-buffers window-next-sibling window-new-normal
window-new-total window-normal-size window-parameter window-parameters
window-parent window-pixel-edges window-point window-prev-buffers
window-parent window-pixel-edges window-point window-prev-buffers
window-prev-sibling window-redisplay-end-trigger window-scroll-bars
window-start window-text-height window-top-child window-top-line
window-total-height window-total-width window-use-time window-vscroll
......
......@@ -2405,7 +2405,7 @@ Argument END is the maximum bounds to search in."
According to the documentation for the function `error', the error list
should not end with a period, and should start with a capital letter.
The function `y-or-n-p' has similar constraints.
Argument TYPE specifies the type of question, such as `error or `y-or-n-p."
Argument TYPE specifies the type of question, such as `error' or `y-or-n-p'."
;; If type is nil, then attempt to derive it.
(if (not type)
(save-excursion
......
......@@ -704,7 +704,7 @@ of values. Callers can retrieve each value using `iter-next'."
(defun iter-next (iterator &optional yield-result)
"Extract a value from an iterator.
YIELD-RESULT becomes the return value of `iter-yield` in the
YIELD-RESULT becomes the return value of `iter-yield' in the
context of the generator.
This routine raises the `iter-end-of-sequence' condition if the
......
......@@ -652,7 +652,7 @@ EVENT is the message received from the closed connection process."
(run-at-time erc-server-reconnect-timeout nil
#'erc-process-sentinel-2
event buffer)
(error (concat "`erc-server-reconnect-timeout`"
(error (concat "`erc-server-reconnect-timeout'"
" must be a number")))))))))))
(defun erc-process-sentinel-1 (event buffer)
......
......@@ -619,7 +619,7 @@ VALUE must be a string specifying the font family
`:foundry'
VALUE must be a string specifying the font foundry,
e.g. ``adobe''. If a font foundry is specified, wild-cards `*'
e.g., \"adobe\". If a font foundry is specified, wild-cards `*'
and `?' are allowed.
`:width'
......@@ -892,7 +892,7 @@ where COLOR is a string or `foreground-color', and STYLE is either
foreground color. :style may be omitted, which means to use a line.
FRAME nil or not specified means change face on all frames.
Use `set-face-attribute' to ``unspecify'' underlining."
Use `set-face-attribute' to unspecify underlining."
(interactive (read-face-and-attribute :underline))
(set-face-attribute face frame :underline underline))
......@@ -905,7 +905,7 @@ Use `set-face-attribute' to ``unspecify'' underlining."
INVERSE-VIDEO-P non-nil means FACE displays explicitly in inverse video.
INVERSE-VIDEO-P nil means FACE explicitly is not in inverse video.
FRAME nil or not specified means change face on all frames.
Use `set-face-attribute' to ``unspecify'' the inverse video attribute."
Use `set-face-attribute' to unspecify the inverse video attribute."
(interactive
(let ((list (read-face-and-attribute :inverse-video)))
(list (car list) (if (cadr list) t))))
......@@ -2042,7 +2042,7 @@ Value is the new parameter list."
"Create and return a frame with frame parameters PARAMETERS.
If PARAMETERS specify a frame name, handle X geometry resources
for that name. If PARAMETERS includes a `reverse' parameter, or
the X resource ``reverseVideo'' is present, handle that."
the X resource \"reverseVideo\" is present, handle that."
(setq parameters (x-handle-named-frame-geometry parameters))
(let* ((params (copy-tree parameters))
(visibility-spec (assq 'visibility parameters))
......
......@@ -1755,7 +1755,7 @@ Otherwise enables edit mode if the visited file is writable."
With ARG: store the record after the current one.
If `forms-new-record-filter' contains the name of a function,
it is called to fill (some of) the fields with default values.
If `forms-insert-after is non-nil, the default behavior is to insert
If `forms-insert-after' is non-nil, the default behavior is to insert
after the current record."
(interactive "P")
......
......@@ -35,8 +35,9 @@
;; Verifying Cancel-Lock is mainly a function of news servers, however,
;; you can verify your own article using the command `canlock-verify' in
;; the (raw) article buffer. You will be prompted for the password for
;; each time if the option `canlock-password' or `canlock-password-for-
;; verify' is nil. Note that setting these options is a bit unsafe.
;; each time if the option `canlock-password' or
;; `canlock-password-for-verify' is nil. Note that setting these
;; options is a bit unsafe.
;;; Code:
......
......@@ -110,7 +110,7 @@
;; > Bye, John
;;
;; Repairing the attribution line will be done by function
;; `gnus-article-outlook-repair-attribution which calls other function that
;; `gnus-article-outlook-repair-attribution' which calls other function that
;; try to recognize and repair broken attribution lines. See variable
;; `gnus-outlook-deuglify-attrib-cut-regexp' for stuff that should be
;; cut off from the beginning of an attribution line and variable
......@@ -121,7 +121,7 @@
;; Rearranging the article so that the cited text appears above the
;; new text will be done by function
;; `gnus-article-outlook-rearrange-citation'. This function calls
;; `gnus-article-outlook-repair-attribution to find and repair an attribution
;; `gnus-article-outlook-repair-attribution' to find and repair an attribution
;; line.
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
......@@ -177,14 +177,14 @@
;; As I said before there may (or will) be a few false positives on
;; unwrapping cited lines with `gnus-article-outlook-unwrap-lines'.
;;
;; `gnus-article-outlook-repair-attribution will only fix the first
;; `gnus-article-outlook-repair-attribution' will only fix the first
;; attribution line found in the article. Furthermore it fixed to
;; certain kinds of attributions. And there may be horribly many
;; false positives, vanishing lines and so on -- so don't trust your
;; eyes. Again I recommend manual invocation.
;;
;; `gnus-article-outlook-rearrange-citation' carries all the limitations of
;; `gnus-article-outlook-repair-attribution.
;; `gnus-article-outlook-repair-attribution'.
;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
......
......@@ -1256,7 +1256,7 @@ how to control what it hides."
:type gnus-article-treat-custom)
(defcustom gnus-treat-strip-list-identifiers 'head
"Strip list identifiers from `gnus-list-identifiers`.
"Strip list identifiers from `gnus-list-identifiers'.
Valid values are nil, t, `head', `first', `last', an integer or a
predicate. See Info node `(gnus)Customizing Articles'."
:version "21.1"
......@@ -1735,7 +1735,7 @@ regexp."
(modify-syntax-entry ?` " " table)
table)
"Syntax table used in article mode buffers.
Initialized from `text-mode-syntax-table.")
Initialized from `text-mode-syntax-table'.")
(defvar gnus-save-article-buffer nil)
......
......@@ -3285,7 +3285,7 @@ mail messages or news articles in files that have numeric names."
Rights is a string listing a (possibly empty) set of alphanumeric
characters, each character listing a set of operations which is being
controlled. Letters are reserved for ``standard'' rights, listed
controlled. Letters are reserved for standard rights, listed
below. Digits are reserved for implementation or site defined rights.
l - lookup (mailbox is visible to LIST/LSUB commands)
......
......@@ -377,7 +377,7 @@ use either \\[customize] or the function `ido-mode'."
'("\\` ")
"List of regexps or functions matching buffer names to ignore.
For example, traditional behavior is not to list buffers whose names begin
with a space, for which the regexp is `\\` '. See the source file for
with a space, for which the regexp is \\` . See the source file for
example functions that filter buffer names."
:type '(repeat (choice regexp function))
:group 'ido)
......@@ -386,7 +386,7 @@ example functions that filter buffer names."
'("\\`CVS/" "\\`#" "\\`.#" "\\`\\.\\./" "\\`\\./")
"List of regexps or functions matching file names to ignore.
For example, traditional behavior is not to list files whose names begin
with a #, for which the regexp is `\\`#'. See the source file for
with a #, for which the regexp is \\`#. See the source file for
example functions that filter filenames."
:type '(repeat (choice regexp function))
:group 'ido)
......
......@@ -1244,8 +1244,8 @@ Unicode based."
This phonetic layout replaces all the Latin letters with Bulgarian
\(Cyrillic) letters based on similarities in their pronunciation or look.
Note that, since the letters 'щ', 'ь', 'ю' and 'я' are attached to the
']', '\', '`' and '[' keys respectively, Caps Lock does not affect them."
Note that, since the letters ‘щ’, ‘ь’, ‘ю’ and ‘я’ are attached to the
‘]’, ‘\’, ‘`’ and ‘[’ keys respectively, Caps Lock does not affect them."
nil t t t t nil nil nil nil nil t)
;; Ю 1! 2@ 3№ 4$ 5% 6€ 7§ 8* 9( 0) -– =+ ьѝ
......
......@@ -49,8 +49,8 @@ C-F9 or `M-x ethio-toggle-space'
Toggles space characters for keyboard input. The current mode is
indicated in mode-line, whether by `_' (ASCII space) or `፡'
(Ethiopic colon-like word separator). Even in the `፡' mode, an
ASCII space is inserted if the point is preceded by `an Ethiopic
punctuation followed by zero or more ASCII spaces'.
ASCII space is inserted if the point is preceded by an Ethiopic
punctuation char that is followed by zero or more ASCII spaces.
S-F5 or `M-x ethio-toggle-punctuation'
Toggles ASCII punctuation and Ethiopic punctuation for keyboard input.
......
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