GNU bug report logs - #35702
xref revert-buffer

Previous Next

Full log

View this message in rfc822 format

From: Eli Zaretskii <eliz <at> gnu.org>
To: Dmitry Gutov <dgutov <at> yandex.ru>
Cc: 35702 <at> debbugs.gnu.org, juri <at> linkov.net
Subject: bug#35702: xref revert-buffer
Date: Sun, 26 May 2019 19:44:53 +0300

> Cc: 35702 <at> debbugs.gnu.org, juri <at> linkov.net
> From: Dmitry Gutov <dgutov <at> yandex.ru>
> Date: Sun, 26 May 2019 00:33:33 +0300
> 
> On 25.05.2019 19:49, Eli Zaretskii wrote:
> 
> > Then I already asked those questions.  The most important one is what
> > values can the fetcher variable have, and in what situations (i.e.,
> > triggered by what command(s)) will we see each value.
> 
> It's akin to asking what values could revert-buffer-function have: 
> different ones.

Although in theory there could indeed be an infinite number of values,
in practice the current actual set is very small, and can be easily
described.  If you want to avoid the (IMO imaginary) danger of
implying there could be no other values, you can say explicitly that
other values are possible.

IOW, useful documentation should be general, but not too general.  If
being general means refraining saying something that could potentially
help the reader understand the software and use it, then you are
probably on the wrong side of "too general".

> I have added some more docstrings and a comment, though. Hope they clear 
> up a few things.

Thanks.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.