From f8284f1e408b38e6a3c0e2a1d5a465fefac6800a Mon Sep 17 00:00:00 2001 From: Paul Eggert Date: Fri, 8 Nov 2019 17:07:13 -0800 Subject: [PATCH] Fix some quoting glitches in doc strings This also fixes a misplaced "only". --- lisp/files.el | 2 +- lisp/mouse.el | 6 ++-- lisp/progmodes/sql.el | 2 +- lisp/progmodes/vhdl-mode.el | 4 +-- lisp/so-long.el | 8 ++--- lisp/subr.el | 10 +++--- lisp/tab-bar.el | 2 +- lisp/window.el | 70 ++++++++++++++++++------------------- src/nsfns.m | 2 +- src/process.c | 2 +- src/window.c | 8 ++--- 11 files changed, 58 insertions(+), 58 deletions(-) diff --git a/lisp/files.el b/lisp/files.el index 7690357058b..f7726b566a9 100644 --- a/lisp/files.el +++ b/lisp/files.el @@ -6864,7 +6864,7 @@ regardless of the language.") The return value is a cons (DIR . WILDCARDS); DIR is the `default-directory' in the Dired buffer, and WILDCARDS are the wildcards. -Valid wildcards are '*', '?', '[abc]' and '[a-z]'." +Valid wildcards are `*', `?', `[abc]' and `[a-z]'." (let ((wildcards "[?*")) (when (and (or (not (featurep 'ls-lisp)) ls-lisp-support-shell-wildcards) diff --git a/lisp/mouse.el b/lisp/mouse.el index 4a351f7be25..238852ffdc8 100644 --- a/lisp/mouse.el +++ b/lisp/mouse.el @@ -622,9 +622,9 @@ START-EVENT is the starting mouse event of the drag action. Its position window denotes the frame that will be dragged. PART specifies the part that has been dragged and must be one of -the symbols 'left', 'top', 'right', 'bottom', 'top-left', -'top-right', 'bottom-left', 'bottom-right' to drag an internal -border or edge. If PART equals 'move', this means to move the +the symbols `left', `top', `right', `bottom', `top-left', +`top-right', `bottom-left', `bottom-right' to drag an internal +border or edge. If PART equals `move', this means to move the frame with the mouse." ;; Give temporary modes such as isearch a chance to turn off. (run-hooks 'mouse-leave-buffer-hook) diff --git a/lisp/progmodes/sql.el b/lisp/progmodes/sql.el index b17364b08f3..aa42873a3dd 100644 --- a/lisp/progmodes/sql.el +++ b/lisp/progmodes/sql.el @@ -5418,7 +5418,7 @@ The default comes from `process-coding-system-alist' and your might try undecided-dos as a coding system. If this doesn't help, Try to set `comint-output-filter-functions' like this: -\(add-hook 'comint-output-filter-functions #\\='comint-strip-ctrl-m 'append) +\(add-hook \\='comint-output-filter-functions #\\='comint-strip-ctrl-m \\='append) \(Type \\[describe-mode] in the SQL buffer for a list of commands.)" (interactive "P") diff --git a/lisp/progmodes/vhdl-mode.el b/lisp/progmodes/vhdl-mode.el index 50b5ad0816e..16ddcdebc9f 100644 --- a/lisp/progmodes/vhdl-mode.el +++ b/lisp/progmodes/vhdl-mode.el @@ -4867,8 +4867,8 @@ Known problems: - XEmacs: Incorrect start-up when automatically opening speedbar. - XEmacs: Indentation in XEmacs 21.4 (and higher). -- Indentation incorrect for new 'postponed' VHDL keyword. -- Indentation incorrect for 'protected body' construct. +- Indentation incorrect for new `postponed' VHDL keyword. +- Indentation incorrect for `protected body' construct. The VHDL Mode Authors diff --git a/lisp/so-long.el b/lisp/so-long.el index e2467e4f0f3..43602b48313 100644 --- a/lisp/so-long.el +++ b/lisp/so-long.el @@ -1174,7 +1174,7 @@ enabled, and `so-long-predicate' has detected that the file contains long lines. Many Emacs modes struggle with buffers which contain excessively long lines, and may consequently cause unacceptable performance issues. -This is commonly on account of 'minified' code (i.e. code has been compacted +This is commonly on account of \"minified\" code (i.e., code compacted into the smallest file size possible, which often entails removing newlines should they not be strictly necessary). These kinds of files are typically not intended to be edited, so not providing the usual editing mode in these @@ -1626,9 +1626,9 @@ Equivalent to calling (global-so-long-mode 0)" Many Emacs modes struggle with buffers which contain excessively long lines, and may consequently cause unacceptable performance issues. -This is commonly on account of 'minified' code (i.e. code that has been -compacted into the smallest file size possible, which often entails removing -newlines should they not be strictly necessary). +This is commonly on account of \"minified\" code (i.e., code compacted into the +smallest file size possible, which often entails removing newlines should they +not be strictly necessary). When such files are detected by `so-long-predicate', we invoke the selected `so-long-action' to mitigate potential performance problems in the buffer. diff --git a/lisp/subr.el b/lisp/subr.el index 03cf3da278f..85e7187fb6b 100644 --- a/lisp/subr.el +++ b/lisp/subr.el @@ -838,9 +838,9 @@ destructively modifying the list stored in ALIST. Example: - (setq foo '((a . 0))) - (setf (alist-get 'a foo) 1 - (alist-get 'b foo) 2) + (setq foo \\='((a . 0))) + (setf (alist-get \\='a foo) 1 + (alist-get \\='b foo) 2) foo => ((b . 2) (a . 1)) @@ -852,8 +852,8 @@ deleted from the alist). Example: - (setq foo '((a . 1) (b . 2))) - (setf (alist-get 'b foo nil 'remove) nil) + (setq foo \\='((a . 1) (b . 2))) + (setf (alist-get \\='b foo nil \\='remove) nil) foo => ((a . 1))" (ignore remove) ;;Silence byte-compiler. diff --git a/lisp/tab-bar.el b/lisp/tab-bar.el index e915930c274..e00839572c8 100644 --- a/lisp/tab-bar.el +++ b/lisp/tab-bar.el @@ -350,7 +350,7 @@ Also add the number of windows in the window configuration." "Function to get a list of tabs to display in the tab bar. This function should return a list of alists with parameters that include at least the element (name . TAB-NAME). -For example, '((tab (name . \"Tab 1\")) (current-tab (name . \"Tab 2\"))) +For example, \\='((tab (name . \"Tab 1\")) (current-tab (name . \"Tab 2\"))) By default, use function `tab-bar-tabs'.") (defun tab-bar-tabs () diff --git a/lisp/window.el b/lisp/window.el index bf213547039..74780479393 100644 --- a/lisp/window.el +++ b/lisp/window.el @@ -2292,14 +2292,14 @@ SIDE can be any of the symbols `left', `top', `right' or "Return window in DIRECTION as seen from WINDOW. More precisely, return the nearest window in direction DIRECTION as seen from the position of `window-point' in window WINDOW. -DIRECTION should be one of 'above', 'below', 'left' or 'right'. +DIRECTION should be one of `above', `below', `left' or `right'. WINDOW must be a live window and defaults to the selected one. -Do not return a window whose 'no-other-window' parameter is -non-nil. If the nearest window's 'no-other-window' parameter is +Do not return a window whose `no-other-window' parameter is +non-nil. If the nearest window's `no-other-window' parameter is non-nil, try to find another window in the indicated direction. If, however, the optional argument IGNORE is non-nil, return that -window even if its 'no-other-window' parameter is non-nil. +window even if its `no-other-window' parameter is non-nil. Optional argument SIGN a negative number means to use the right or bottom edge of WINDOW as reference position instead of @@ -2308,7 +2308,7 @@ top edge of WINDOW as reference position. Optional argument WRAP non-nil means to wrap DIRECTION around frame borders. This means to return for WINDOW at the top of the -frame and DIRECTION 'above' the minibuffer window if the frame +frame and DIRECTION `above' the minibuffer window if the frame has one, and a window at the bottom of the frame otherwise. Optional argument MINI nil means to return the minibuffer window @@ -5058,29 +5058,29 @@ absolute value can be less than `window-min-height' or small as one line or two columns. SIZE defaults to half of WINDOW's size. -Optional third argument SIDE nil (or 'below') specifies that the -new window shall be located below WINDOW. SIDE 'above' means the +Optional third argument SIDE nil (or `below') specifies that the +new window shall be located below WINDOW. SIDE `above' means the new window shall be located above WINDOW. In both cases SIZE specifies the new number of lines for WINDOW (or the new window if SIZE is negative) including space reserved for the mode and/or header line. -SIDE t (or 'right') specifies that the new window shall be -located on the right side of WINDOW. SIDE 'left' means the new +SIDE t (or `right') specifies that the new window shall be +located on the right side of WINDOW. SIDE `left' means the new window shall be located on the left of WINDOW. In both cases SIZE specifies the new number of columns for WINDOW (or the new window provided SIZE is negative) including space reserved for fringes and the scrollbar or a divider column. -For compatibility reasons, SIDE 'up' and 'down' are interpreted -as 'above' and 'below'. Any other non-nil value for SIDE is -currently handled like t (or 'right'). +For compatibility reasons, SIDE `up' and `down' are interpreted +as `above' and `below'. Any other non-nil value for SIDE is +currently handled like t (or `right'). PIXELWISE, if non-nil, means to interpret SIZE pixelwise. If the variable `ignore-window-parameters' is non-nil or the -'split-window' parameter of WINDOW equals t, do not process any -parameters of WINDOW. Otherwise, if the 'split-window' parameter +`split-window' parameter of WINDOW equals t, do not process any +parameters of WINDOW. Otherwise, if the `split-window' parameter of WINDOW specifies a function, call that function with all three arguments and return the value returned by that function. @@ -6896,18 +6896,18 @@ already before that action function was called or is a new window created by that function. ALIST is a buffer display action alist as compiled by `display-buffer'. -TYPE must be one of the following symbols: 'reuse' (which means +TYPE must be one of the following symbols: `reuse' (which means WINDOW existed before the call of `display-buffer' and may -already show BUFFER or not), 'window' (WINDOW was created on an -existing frame) or 'frame' (WINDOW was created on a new frame). +already show BUFFER or not), `window' (WINDOW was created on an +existing frame) or `frame' (WINDOW was created on a new frame). TYPE is passed unaltered to `display-buffer-record-window'. Handle WINDOW's dedicated flag as follows: If WINDOW already shows BUFFER, leave it alone. Otherwise, if ALIST contains a -'dedicated' entry and WINDOW is either new or that entry's value -equals 'side', set WINDOW's dedicated flag to the value of that +`dedicated' entry and WINDOW is either new or that entry's value +equals `side', set WINDOW's dedicated flag to the value of that entry. Otherwise, if WINDOW is new and the value of -'display-buffer-mark-dedicated' is non-nil, set WINDOW's +`display-buffer-mark-dedicated' is non-nil, set WINDOW's dedicated flag to that value. In any other case, reset WINDOW's dedicated flag to nil. @@ -7227,18 +7227,18 @@ Action functions and the action they try to perform are: have `display-buffer' return nil immediately. Action alist entries are: - 'inhibit-same-window' -- A non-nil value prevents the same + `inhibit-same-window' -- A non-nil value prevents the same window from being used for display. - 'inhibit-switch-frame' -- A non-nil value prevents any frame + `inhibit-switch-frame' -- A non-nil value prevents any frame used for showing the buffer from being raised or selected. - 'reusable-frames' -- The value specifies the set of frames to + `reusable-frames' -- The value specifies the set of frames to search for a window that already displays the buffer. Possible values are nil (the selected frame), t (any live frame), visible (any visible frame), 0 (any visible or iconified frame) or an existing live frame. - 'pop-up-frame-parameters' -- The value specifies an alist of + `pop-up-frame-parameters' -- The value specifies an alist of frame parameters to give a new frame, if one is created. - 'window-height' -- The value specifies the desired height of the + `window-height' -- The value specifies the desired height of the window chosen and is either an integer (the total height of the window), a floating point number (the fraction of its total height with respect to the total height of the frame's @@ -7247,23 +7247,23 @@ Action alist entries are: height of the window; its return value is ignored. Suitable functions are `shrink-window-if-larger-than-buffer' and `fit-window-to-buffer'. - 'window-width' -- The value specifies the desired width of the + `window-width' -- The value specifies the desired width of the window chosen and is either an integer (the total width of the window), a floating point number (the fraction of its total width with respect to the width of the frame's root window) or a function to be called with one argument - the chosen window. The function is supposed to adjust the width of the window; its return value is ignored. - 'preserve-size' -- The value should be either (t . nil) to + `preserve-size' -- The value should be either (t . nil) to preserve the width of the chosen window, (nil . t) to preserve its height or (t . t) to preserve its height and width in future changes of the window configuration. - 'window-parameters' -- The value specifies an alist of window + `window-parameters' -- The value specifies an alist of window parameters to give the chosen window. - 'allow-no-window' -- A non-nil value means that `display-buffer' + `allow-no-window' -- A non-nil value means that `display-buffer' may not display the buffer and return nil immediately. -The entries 'window-height', 'window-width' and 'preserve-size' +The entries `window-height', `window-width' and `preserve-size' are applied only when the window used for displaying the buffer never showed another buffer before. @@ -7710,16 +7710,16 @@ indirectly called by the latter." (defun windows-sharing-edge (&optional window edge within) "Return list of live windows sharing the same edge with WINDOW. WINDOW must be a valid window and defaults to the selected one. -EDGE stands for the edge to share and must be either 'left', -'above', 'right' or 'below'. Omitted or nil, EDGE defaults to -'left'. +EDGE stands for the edge to share and must be either `left', +`above', `right' or `below'. Omitted or nil, EDGE defaults to +`left'. WITHIN nil means to find a live window that shares the opposite -EDGE with WINDOW. For example, if EDGE equals 'left', WINDOW has +EDGE with WINDOW. For example, if EDGE equals `left', WINDOW has to share (part of) the right edge of any window returned. WITHIN non-nil means to find all live windows that share the same EDGE with WINDOW (Window must be internal in this case). So if EDGE -equals 'left', WINDOW's left edge has to fully encompass the left +equals `left', WINDOW's left edge has to fully encompass the left edge of any window returned." (setq window (window-normalize-window window)) (setq edge (or edge 'left)) diff --git a/src/nsfns.m b/src/nsfns.m index 184fd71678e..4c1fb76deae 100644 --- a/src/nsfns.m +++ b/src/nsfns.m @@ -1971,7 +1971,7 @@ the active application. */) DEFUN ("ns-emacs-info-panel", Fns_emacs_info_panel, Sns_emacs_info_panel, 0, 0, 0, - doc: /* Shows the 'Info' or 'About' panel for Emacs. */) + doc: /* Shows the `Info' or `About' panel for Emacs. */) (void) { check_window_system (NULL); diff --git a/src/process.c b/src/process.c index 8aa4811f7ed..9158cfd347c 100644 --- a/src/process.c +++ b/src/process.c @@ -3761,7 +3761,7 @@ host, and only clients connecting to that address will be accepted. If all interfaces should be bound, an address of \"0.0.0.0\" (for IPv4) or \"::\" (for IPv6) can be used. (On some operating systems, using \"::\" listens on both IPv4 and IPv6.) `local' will use IPv4 by -default, use a FAMILY of 'ipv6 to override this. +default, use a FAMILY of `ipv6' to override this. :service SERVICE -- SERVICE is name of the service desired, or an integer specifying a port number to connect to. If SERVICE is t, diff --git a/src/window.c b/src/window.c index 0fa0bdf7b92..e122649f59e 100644 --- a/src/window.c +++ b/src/window.c @@ -3539,8 +3539,8 @@ DEFUN ("run-window-scroll-functions", Frun_window_scroll_functions, doc: /* Run `window-scroll-functions' for WINDOW. If WINDOW is omitted or nil, it defaults to the selected window. -This function is curently only called by 'split-window' for the new -window after it has established the size of the new window. */) +This function is called by `split-window' for the new window, after it +has established the size of the new window. */) (Lisp_Object window) { struct window *w = decode_live_window (window); @@ -7661,7 +7661,7 @@ display marginal areas and the text area. Optional fifth argument PERSISTENT non-nil means that fringe settings for WINDOW are persistent, i.e., remain unchanged when another buffer is shown in WINDOW. PERSISTENT nil means that fringes are reset from -buffer local values when 'set-window-buffer' is called on WINDOW with +buffer local values when `set-window-buffer' is called on WINDOW with the argument KEEP-MARGINS nil. Leave fringes unchanged if WINDOW is not large enough to accommodate @@ -7812,7 +7812,7 @@ order to show a scroll bar for mini windows. Optional sixth argument PERSISTENT non-nil means that scroll bar settings for WINDOW are persistent, i.e., remain unchanged when another buffer is shown in WINDOW. PERSISTENT nil means that scroll -bars are reset from buffer local values when 'set-window-buffer' is +bars are reset from buffer local values when `set-window-buffer' is called on WINDOW with the argument KEEP-MARGINS nil. If WINDOW is not large enough to accommodate a scroll bar of the -- 2.39.5