summaryrefslogtreecommitdiff
path: root/lisp/progmodes/xref.el
diff options
context:
space:
mode:
authorDmitry Gutov <dgutov@yandex.ru>2022-11-28 03:07:01 +0200
committerDmitry Gutov <dgutov@yandex.ru>2022-11-28 03:07:15 +0200
commit99463478e5aabe35593cf9127f37ae77d613b775 (patch)
tree6790813f44c91f50e7ee8d58ee3908f5c162fbb9 /lisp/progmodes/xref.el
parent059467ddc254a99afb59f04d85d2d2208ff64299 (diff)
downloademacs-99463478e5aabe35593cf9127f37ae77d613b775.tar.gz
* lisp/progmodes/xref.el (xref--outdated-p): Fix broken docstring.
Diffstat (limited to 'lisp/progmodes/xref.el')
-rw-r--r--lisp/progmodes/xref.el7
1 files changed, 6 insertions, 1 deletions
diff --git a/lisp/progmodes/xref.el b/lisp/progmodes/xref.el
index 4bdaf58cc03..1e4aa4eba52 100644
--- a/lisp/progmodes/xref.el
+++ b/lisp/progmodes/xref.el
@@ -885,7 +885,12 @@ some of the references to the identifiers."
(defun xref--outdated-p (item)
"Check that the match location at current position is up-to-date.
-ITEMS is an xref item which " ; FIXME: Expand documentation.
+
+ITEM is an xref item which is expected to be produced by a search
+command and have summary that matches buffer contents near point.
+Depending on whether it's the first of the matches on the line,
+the summary should either start from bol, or only match after
+point."
;; FIXME: The check should most likely be a generic function instead
;; of the assumption that all matches' summaries relate to the
;; buffer text in a particular way.