From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Eli Zaretskii Newsgroups: gmane.emacs.bugs Subject: bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file'. Date: Wed, 09 Oct 2019 11:09:16 +0300 Message-ID: <83a7aawdar.fsf@gnu.org> References: <36bef08c-45b5-9cce-5374-d4de4260d39a@topbug.net> <838sq8j0vl.fsf@gnu.org> <7e0290a2-e80b-f566-9c3b-894aaf4e5d9d@topbug.net> <87o8yt9oql.fsf@gnus.org> <83y2xwzfz0.fsf@gnu.org> <860671c8-787c-512c-8df6-ea1d9dfc2f5b@topbug.net> <874l0j1a3j.fsf@gnus.org> <663aaf32-97c4-0723-1a30-a644938bd21f@topbug.net> Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="176150"; mail-complaints-to="usenet@blaine.gmane.org" Cc: larsi@gnus.org, 37538@debbugs.gnu.org To: Hong Xu Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Wed Oct 09 18:52:18 2019 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane.org Original-Received: from lists.gnu.org ([209.51.188.17]) by blaine.gmane.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.89) (envelope-from ) id 1iIFCB-000je1-Gw for geb-bug-gnu-emacs@m.gmane.org; Wed, 09 Oct 2019 18:52:15 +0200 Original-Received: from localhost ([::1]:52564 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iIFC9-00006P-TQ for geb-bug-gnu-emacs@m.gmane.org; Wed, 09 Oct 2019 12:52:13 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:43820) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iI72q-0004wJ-1h for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 04:10:07 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iI72p-0007OM-27 for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 04:10:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:43247) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iI72o-0007OD-Uz for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 04:10:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iI72o-0006Gs-N6 for bug-gnu-emacs@gnu.org; Wed, 09 Oct 2019 04:10:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Eli Zaretskii Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Wed, 09 Oct 2019 08:10:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 37538 X-GNU-PR-Package: emacs X-GNU-PR-Keywords: fixed patch Original-Received: via spool by 37538-submit@debbugs.gnu.org id=B37538.157060858024069 (code B ref 37538); Wed, 09 Oct 2019 08:10:02 +0000 Original-Received: (at 37538) by debbugs.gnu.org; 9 Oct 2019 08:09:40 +0000 Original-Received: from localhost ([127.0.0.1]:52068 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iI72S-0006G8-5m for submit@debbugs.gnu.org; Wed, 09 Oct 2019 04:09:40 -0400 Original-Received: from eggs.gnu.org ([209.51.188.92]:34693) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iI72Q-0006Fu-KR for 37538@debbugs.gnu.org; Wed, 09 Oct 2019 04:09:39 -0400 Original-Received: from fencepost.gnu.org ([2001:470:142:3::e]:37201) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1iI72L-0007BE-Ef; Wed, 09 Oct 2019 04:09:33 -0400 Original-Received: from [176.228.60.248] (port=4681 helo=home-c4e4a596f7) by fencepost.gnu.org with esmtpsa (TLS1.2:RSA_AES_256_CBC_SHA1:256) (Exim 4.82) (envelope-from ) id 1iI72K-0003Y5-UN; Wed, 09 Oct 2019 04:09:33 -0400 In-reply-to: <663aaf32-97c4-0723-1a30-a644938bd21f@topbug.net> (message from Hong Xu on Tue, 8 Oct 2019 23:39:08 -0700) X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-detected-operating-system: by eggs.gnu.org: GNU/Linux 2.2.x-3.x [generic] X-Received-From: 209.51.188.43 X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Original-Sender: "bug-gnu-emacs" Xref: news.gmane.org gmane.emacs.bugs:168715 Archived-At: > Cc: Eli Zaretskii , 37538@debbugs.gnu.org > From: Hong Xu > 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.