diff options
| author | Eli Zaretskii <eliz@gnu.org> | 2022-11-25 15:29:10 +0200 |
|---|---|---|
| committer | Eli Zaretskii <eliz@gnu.org> | 2022-11-25 15:29:10 +0200 |
| commit | af545234314601ba3dcd8bf32e0d9b46e1917f79 (patch) | |
| tree | 504ca0e69265586deb376d4f9d1a61500a188fb7 | |
| parent | 98c69b255663dd869fa22c7366f254b10ff29cad (diff) | |
| download | emacs-af545234314601ba3dcd8bf32e0d9b46e1917f79.tar.gz | |
; Fix doc strings in xref.el
* lisp/progmodes/xref.el (xref-history-storage)
(xref-global-history, xref-window-local-history): Doc fixes.
| -rw-r--r-- | lisp/progmodes/xref.el | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el index 071636dd8d7..c72041d70f9 100644 --- a/lisp/progmodes/xref.el +++ b/lisp/progmodes/xref.el @@ -432,18 +432,20 @@ or earlier: it can break `dired-do-find-regexp-and-replace'." (defcustom xref-history-storage #'xref-global-history "Function that returns xref history. -The following functions are predefined: +The following functions that can be used as this variable's value +are predefined: - `xref-global-history' Return a single, global history used across the entire Emacs - instance. + session. This is the default. - `xref-window-local-history' - Return different xref histories, one per window. Allows you - to navigate code independently in different windows. A new + Return separate xref histories, one per window. Allows + independent navigation of code in each window. A new xref history is created for every new window." :type '(radio - (function-item :tag "Per-window" xref-window-local-history) - (function-item :tag "Global history for Emacs instance" xref-global-history) + (function-item :tag "Per-window history" xref-window-local-history) + (function-item :tag "Global history for Emacs session" + xref-global-history) (function :tag "Other")) :version "29.1" :package-version '(xref . "1.6.0")) @@ -462,7 +464,7 @@ The following functions are predefined: "(BACKWARD-STACK . FORWARD-STACK) of markers to visited Xref locations.") (defun xref-global-history (&optional new-value) - "Return the xref history global to this Emacs instance. + "Return the xref history that is global for the current Emacs session. Override existing value with NEW-VALUE if NEW-VALUE is set." (if new-value @@ -470,7 +472,7 @@ Override existing value with NEW-VALUE if NEW-VALUE is set." xref--history)) (defun xref-window-local-history (&optional new-value) - "Return window-local xref history. + "Return window-local xref history for the selected window. Override existing value with NEW-VALUE if NEW-VALUE is set." (let ((w (selected-window))) |