diff options
| author | Paul Eggert | 2019-11-08 17:07:13 -0800 |
|---|---|---|
| committer | Paul Eggert | 2019-11-08 17:11:01 -0800 |
| commit | f8284f1e408b38e6a3c0e2a1d5a465fefac6800a (patch) | |
| tree | 968d78aea467a7f574227bdb46073a15e4372efb /lisp/window.el | |
| parent | b7f843adfd91bdbb24af7539a782d12767646fce (diff) | |
| download | emacs-f8284f1e408b38e6a3c0e2a1d5a465fefac6800a.tar.gz emacs-f8284f1e408b38e6a3c0e2a1d5a465fefac6800a.zip | |
Fix some quoting glitches in doc strings
This also fixes a misplaced "only".
Diffstat (limited to 'lisp/window.el')
| -rw-r--r-- | lisp/window.el | 70 |
1 files changed, 35 insertions, 35 deletions
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 | |||
| 2292 | "Return window in DIRECTION as seen from WINDOW. | 2292 | "Return window in DIRECTION as seen from WINDOW. |
| 2293 | More precisely, return the nearest window in direction DIRECTION | 2293 | More precisely, return the nearest window in direction DIRECTION |
| 2294 | as seen from the position of `window-point' in window WINDOW. | 2294 | as seen from the position of `window-point' in window WINDOW. |
| 2295 | DIRECTION should be one of 'above', 'below', 'left' or 'right'. | 2295 | DIRECTION should be one of `above', `below', `left' or `right'. |
| 2296 | WINDOW must be a live window and defaults to the selected one. | 2296 | WINDOW must be a live window and defaults to the selected one. |
| 2297 | 2297 | ||
| 2298 | Do not return a window whose 'no-other-window' parameter is | 2298 | Do not return a window whose `no-other-window' parameter is |
| 2299 | non-nil. If the nearest window's 'no-other-window' parameter is | 2299 | non-nil. If the nearest window's `no-other-window' parameter is |
| 2300 | non-nil, try to find another window in the indicated direction. | 2300 | non-nil, try to find another window in the indicated direction. |
| 2301 | If, however, the optional argument IGNORE is non-nil, return that | 2301 | If, however, the optional argument IGNORE is non-nil, return that |
| 2302 | window even if its 'no-other-window' parameter is non-nil. | 2302 | window even if its `no-other-window' parameter is non-nil. |
| 2303 | 2303 | ||
| 2304 | Optional argument SIGN a negative number means to use the right | 2304 | Optional argument SIGN a negative number means to use the right |
| 2305 | or bottom edge of WINDOW as reference position instead of | 2305 | or bottom edge of WINDOW as reference position instead of |
| @@ -2308,7 +2308,7 @@ top edge of WINDOW as reference position. | |||
| 2308 | 2308 | ||
| 2309 | Optional argument WRAP non-nil means to wrap DIRECTION around | 2309 | Optional argument WRAP non-nil means to wrap DIRECTION around |
| 2310 | frame borders. This means to return for WINDOW at the top of the | 2310 | frame borders. This means to return for WINDOW at the top of the |
| 2311 | frame and DIRECTION 'above' the minibuffer window if the frame | 2311 | frame and DIRECTION `above' the minibuffer window if the frame |
| 2312 | has one, and a window at the bottom of the frame otherwise. | 2312 | has one, and a window at the bottom of the frame otherwise. |
| 2313 | 2313 | ||
| 2314 | Optional argument MINI nil means to return the minibuffer window | 2314 | Optional argument MINI nil means to return the minibuffer window |
| @@ -5058,29 +5058,29 @@ absolute value can be less than `window-min-height' or | |||
| 5058 | small as one line or two columns. SIZE defaults to half of | 5058 | small as one line or two columns. SIZE defaults to half of |
| 5059 | WINDOW's size. | 5059 | WINDOW's size. |
| 5060 | 5060 | ||
| 5061 | Optional third argument SIDE nil (or 'below') specifies that the | 5061 | Optional third argument SIDE nil (or `below') specifies that the |
| 5062 | new window shall be located below WINDOW. SIDE 'above' means the | 5062 | new window shall be located below WINDOW. SIDE `above' means the |
| 5063 | new window shall be located above WINDOW. In both cases SIZE | 5063 | new window shall be located above WINDOW. In both cases SIZE |
| 5064 | specifies the new number of lines for WINDOW (or the new window | 5064 | specifies the new number of lines for WINDOW (or the new window |
| 5065 | if SIZE is negative) including space reserved for the mode and/or | 5065 | if SIZE is negative) including space reserved for the mode and/or |
| 5066 | header line. | 5066 | header line. |
| 5067 | 5067 | ||
| 5068 | SIDE t (or 'right') specifies that the new window shall be | 5068 | SIDE t (or `right') specifies that the new window shall be |
| 5069 | located on the right side of WINDOW. SIDE 'left' means the new | 5069 | located on the right side of WINDOW. SIDE `left' means the new |
| 5070 | window shall be located on the left of WINDOW. In both cases | 5070 | window shall be located on the left of WINDOW. In both cases |
| 5071 | SIZE specifies the new number of columns for WINDOW (or the new | 5071 | SIZE specifies the new number of columns for WINDOW (or the new |
| 5072 | window provided SIZE is negative) including space reserved for | 5072 | window provided SIZE is negative) including space reserved for |
| 5073 | fringes and the scrollbar or a divider column. | 5073 | fringes and the scrollbar or a divider column. |
| 5074 | 5074 | ||
| 5075 | For compatibility reasons, SIDE 'up' and 'down' are interpreted | 5075 | For compatibility reasons, SIDE `up' and `down' are interpreted |
| 5076 | as 'above' and 'below'. Any other non-nil value for SIDE is | 5076 | as `above' and `below'. Any other non-nil value for SIDE is |
| 5077 | currently handled like t (or 'right'). | 5077 | currently handled like t (or `right'). |
| 5078 | 5078 | ||
| 5079 | PIXELWISE, if non-nil, means to interpret SIZE pixelwise. | 5079 | PIXELWISE, if non-nil, means to interpret SIZE pixelwise. |
| 5080 | 5080 | ||
| 5081 | If the variable `ignore-window-parameters' is non-nil or the | 5081 | If the variable `ignore-window-parameters' is non-nil or the |
| 5082 | 'split-window' parameter of WINDOW equals t, do not process any | 5082 | `split-window' parameter of WINDOW equals t, do not process any |
| 5083 | parameters of WINDOW. Otherwise, if the 'split-window' parameter | 5083 | parameters of WINDOW. Otherwise, if the `split-window' parameter |
| 5084 | of WINDOW specifies a function, call that function with all three | 5084 | of WINDOW specifies a function, call that function with all three |
| 5085 | arguments and return the value returned by that function. | 5085 | arguments and return the value returned by that function. |
| 5086 | 5086 | ||
| @@ -6896,18 +6896,18 @@ already before that action function was called or is a new window | |||
| 6896 | created by that function. ALIST is a buffer display action alist | 6896 | created by that function. ALIST is a buffer display action alist |
| 6897 | as compiled by `display-buffer'. | 6897 | as compiled by `display-buffer'. |
| 6898 | 6898 | ||
| 6899 | TYPE must be one of the following symbols: 'reuse' (which means | 6899 | TYPE must be one of the following symbols: `reuse' (which means |
| 6900 | WINDOW existed before the call of `display-buffer' and may | 6900 | WINDOW existed before the call of `display-buffer' and may |
| 6901 | already show BUFFER or not), 'window' (WINDOW was created on an | 6901 | already show BUFFER or not), `window' (WINDOW was created on an |
| 6902 | existing frame) or 'frame' (WINDOW was created on a new frame). | 6902 | existing frame) or `frame' (WINDOW was created on a new frame). |
| 6903 | TYPE is passed unaltered to `display-buffer-record-window'. | 6903 | TYPE is passed unaltered to `display-buffer-record-window'. |
| 6904 | 6904 | ||
| 6905 | Handle WINDOW's dedicated flag as follows: If WINDOW already | 6905 | Handle WINDOW's dedicated flag as follows: If WINDOW already |
| 6906 | shows BUFFER, leave it alone. Otherwise, if ALIST contains a | 6906 | shows BUFFER, leave it alone. Otherwise, if ALIST contains a |
| 6907 | 'dedicated' entry and WINDOW is either new or that entry's value | 6907 | `dedicated' entry and WINDOW is either new or that entry's value |
| 6908 | equals 'side', set WINDOW's dedicated flag to the value of that | 6908 | equals `side', set WINDOW's dedicated flag to the value of that |
| 6909 | entry. Otherwise, if WINDOW is new and the value of | 6909 | entry. Otherwise, if WINDOW is new and the value of |
| 6910 | 'display-buffer-mark-dedicated' is non-nil, set WINDOW's | 6910 | `display-buffer-mark-dedicated' is non-nil, set WINDOW's |
| 6911 | dedicated flag to that value. In any other case, reset WINDOW's | 6911 | dedicated flag to that value. In any other case, reset WINDOW's |
| 6912 | dedicated flag to nil. | 6912 | dedicated flag to nil. |
| 6913 | 6913 | ||
| @@ -7227,18 +7227,18 @@ Action functions and the action they try to perform are: | |||
| 7227 | have `display-buffer' return nil immediately. | 7227 | have `display-buffer' return nil immediately. |
| 7228 | 7228 | ||
| 7229 | Action alist entries are: | 7229 | Action alist entries are: |
| 7230 | 'inhibit-same-window' -- A non-nil value prevents the same | 7230 | `inhibit-same-window' -- A non-nil value prevents the same |
| 7231 | window from being used for display. | 7231 | window from being used for display. |
| 7232 | 'inhibit-switch-frame' -- A non-nil value prevents any frame | 7232 | `inhibit-switch-frame' -- A non-nil value prevents any frame |
| 7233 | used for showing the buffer from being raised or selected. | 7233 | used for showing the buffer from being raised or selected. |
| 7234 | 'reusable-frames' -- The value specifies the set of frames to | 7234 | `reusable-frames' -- The value specifies the set of frames to |
| 7235 | search for a window that already displays the buffer. | 7235 | search for a window that already displays the buffer. |
| 7236 | Possible values are nil (the selected frame), t (any live | 7236 | Possible values are nil (the selected frame), t (any live |
| 7237 | frame), visible (any visible frame), 0 (any visible or | 7237 | frame), visible (any visible frame), 0 (any visible or |
| 7238 | iconified frame) or an existing live frame. | 7238 | iconified frame) or an existing live frame. |
| 7239 | 'pop-up-frame-parameters' -- The value specifies an alist of | 7239 | `pop-up-frame-parameters' -- The value specifies an alist of |
| 7240 | frame parameters to give a new frame, if one is created. | 7240 | frame parameters to give a new frame, if one is created. |
| 7241 | 'window-height' -- The value specifies the desired height of the | 7241 | `window-height' -- The value specifies the desired height of the |
| 7242 | window chosen and is either an integer (the total height of | 7242 | window chosen and is either an integer (the total height of |
| 7243 | the window), a floating point number (the fraction of its | 7243 | the window), a floating point number (the fraction of its |
| 7244 | total height with respect to the total height of the frame's | 7244 | total height with respect to the total height of the frame's |
| @@ -7247,23 +7247,23 @@ Action alist entries are: | |||
| 7247 | height of the window; its return value is ignored. Suitable | 7247 | height of the window; its return value is ignored. Suitable |
| 7248 | functions are `shrink-window-if-larger-than-buffer' and | 7248 | functions are `shrink-window-if-larger-than-buffer' and |
| 7249 | `fit-window-to-buffer'. | 7249 | `fit-window-to-buffer'. |
| 7250 | 'window-width' -- The value specifies the desired width of the | 7250 | `window-width' -- The value specifies the desired width of the |
| 7251 | window chosen and is either an integer (the total width of | 7251 | window chosen and is either an integer (the total width of |
| 7252 | the window), a floating point number (the fraction of its | 7252 | the window), a floating point number (the fraction of its |
| 7253 | total width with respect to the width of the frame's root | 7253 | total width with respect to the width of the frame's root |
| 7254 | window) or a function to be called with one argument - the | 7254 | window) or a function to be called with one argument - the |
| 7255 | chosen window. The function is supposed to adjust the width | 7255 | chosen window. The function is supposed to adjust the width |
| 7256 | of the window; its return value is ignored. | 7256 | of the window; its return value is ignored. |
| 7257 | 'preserve-size' -- The value should be either (t . nil) to | 7257 | `preserve-size' -- The value should be either (t . nil) to |
| 7258 | preserve the width of the chosen window, (nil . t) to | 7258 | preserve the width of the chosen window, (nil . t) to |
| 7259 | preserve its height or (t . t) to preserve its height and | 7259 | preserve its height or (t . t) to preserve its height and |
| 7260 | width in future changes of the window configuration. | 7260 | width in future changes of the window configuration. |
| 7261 | 'window-parameters' -- The value specifies an alist of window | 7261 | `window-parameters' -- The value specifies an alist of window |
| 7262 | parameters to give the chosen window. | 7262 | parameters to give the chosen window. |
| 7263 | 'allow-no-window' -- A non-nil value means that `display-buffer' | 7263 | `allow-no-window' -- A non-nil value means that `display-buffer' |
| 7264 | may not display the buffer and return nil immediately. | 7264 | may not display the buffer and return nil immediately. |
| 7265 | 7265 | ||
| 7266 | The entries 'window-height', 'window-width' and 'preserve-size' | 7266 | The entries `window-height', `window-width' and `preserve-size' |
| 7267 | are applied only when the window used for displaying the buffer | 7267 | are applied only when the window used for displaying the buffer |
| 7268 | never showed another buffer before. | 7268 | never showed another buffer before. |
| 7269 | 7269 | ||
| @@ -7710,16 +7710,16 @@ indirectly called by the latter." | |||
| 7710 | (defun windows-sharing-edge (&optional window edge within) | 7710 | (defun windows-sharing-edge (&optional window edge within) |
| 7711 | "Return list of live windows sharing the same edge with WINDOW. | 7711 | "Return list of live windows sharing the same edge with WINDOW. |
| 7712 | WINDOW must be a valid window and defaults to the selected one. | 7712 | WINDOW must be a valid window and defaults to the selected one. |
| 7713 | EDGE stands for the edge to share and must be either 'left', | 7713 | EDGE stands for the edge to share and must be either `left', |
| 7714 | 'above', 'right' or 'below'. Omitted or nil, EDGE defaults to | 7714 | `above', `right' or `below'. Omitted or nil, EDGE defaults to |
| 7715 | 'left'. | 7715 | `left'. |
| 7716 | 7716 | ||
| 7717 | WITHIN nil means to find a live window that shares the opposite | 7717 | WITHIN nil means to find a live window that shares the opposite |
| 7718 | EDGE with WINDOW. For example, if EDGE equals 'left', WINDOW has | 7718 | EDGE with WINDOW. For example, if EDGE equals `left', WINDOW has |
| 7719 | to share (part of) the right edge of any window returned. WITHIN | 7719 | to share (part of) the right edge of any window returned. WITHIN |
| 7720 | non-nil means to find all live windows that share the same EDGE | 7720 | non-nil means to find all live windows that share the same EDGE |
| 7721 | with WINDOW (Window must be internal in this case). So if EDGE | 7721 | with WINDOW (Window must be internal in this case). So if EDGE |
| 7722 | equals 'left', WINDOW's left edge has to fully encompass the left | 7722 | equals `left', WINDOW's left edge has to fully encompass the left |
| 7723 | edge of any window returned." | 7723 | edge of any window returned." |
| 7724 | (setq window (window-normalize-window window)) | 7724 | (setq window (window-normalize-window window)) |
| 7725 | (setq edge (or edge 'left)) | 7725 | (setq edge (or edge 'left)) |