From: Dmitry Gutov <dgutov@yandex.ru>
Date: Mon, 28 Nov 2022 01:07:01 +0000 (+0200)
Subject: * lisp/progmodes/xref.el (xref--outdated-p): Fix broken docstring.
X-Git-Tag: emacs-29.0.90~1442
X-Git-Url: http://git.eshelyaron.com/gitweb/?a=commitdiff_plain;h=99463478e5aabe35593cf9127f37ae77d613b775;p=emacs.git

* lisp/progmodes/xref.el (xref--outdated-p): Fix broken docstring.
---

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.