bug-gnu-emacs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file'.


From: Eli Zaretskii
Subject: bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file'.
Date: Wed, 09 Oct 2019 11:09:16 +0300

> Cc: Eli Zaretskii <eliz@gnu.org>, 37538@debbugs.gnu.org
> From: Hong Xu <hong@topbug.net>
> Date: Tue, 8 Oct 2019 23:39:08 -0700
> 
> On 10/8/19 9:21 AM, Lars Ingebrigtsen wrote:
> > 
> > The problem is that `(elisp) Programmed Completion' (at least in Emacs
> > 27) doesn't mention a WHAT parameter at all, so it's unclear what this
> > refers to.
> 
> How about the following change?

I don't see how it solves the problem, sorry.  It attempts to assign
some significance to the ordinal number of the argument WHAT, in the
hope that the reader will be able to connect the dots.  But a good
documentation should not leave the dots unconnected, it should spell
them out, ideally in one place.

I actually don't understand why we would like to send the reader to
the manual, instead of describing the effects of WHAT in the doc
string.  Can we just say it right there?

Thanks.





reply via email to

[Prev in Thread] Current Thread [Next in Thread]