From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.org!.POSTED.blaine.gmane.org!not-for-mail From: Hong Xu Newsgroups: gmane.emacs.bugs Subject: bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file'. Date: Mon, 7 Oct 2019 10:27:52 -0700 Message-ID: <860671c8-787c-512c-8df6-ea1d9dfc2f5b@topbug.net> 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> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: 7bit Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="11185"; mail-complaints-to="usenet@blaine.gmane.org" User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.9.0 Cc: 37538@debbugs.gnu.org To: Eli Zaretskii , Lars Ingebrigtsen Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Mon Oct 07 19:29:14 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 1iHWoq-0002hl-VL for geb-bug-gnu-emacs@m.gmane.org; Mon, 07 Oct 2019 19:29:13 +0200 Original-Received: from localhost ([::1]:48146 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iHWop-0007x7-JS for geb-bug-gnu-emacs@m.gmane.org; Mon, 07 Oct 2019 13:29:11 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:40473) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iHWoh-0007wc-MP for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:29:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iHWog-00066O-I9 for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:29:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:40212) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iHWog-00066I-FF for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:29:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iHWog-0002GL-8s for bug-gnu-emacs@gnu.org; Mon, 07 Oct 2019 13:29:02 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Hong Xu Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 07 Oct 2019 17:29: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.15704692838613 (code B ref 37538); Mon, 07 Oct 2019 17:29:02 +0000 Original-Received: (at 37538) by debbugs.gnu.org; 7 Oct 2019 17:28:03 +0000 Original-Received: from localhost ([127.0.0.1]:49032 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iHWnj-0002Er-HQ for submit@debbugs.gnu.org; Mon, 07 Oct 2019 13:28:03 -0400 Original-Received: from sender4-of-o54.zoho.com ([136.143.188.54]:21452) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iHWnf-0002EQ-SG for 37538@debbugs.gnu.org; Mon, 07 Oct 2019 13:28:01 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1570469275; cv=none; d=zoho.com; s=zohoarc; b=AIkhBk2I+zWziH6m6dct4GrlRk19WirGnDXHndTHPBNALYd6UXNXKx54t7jLBPdXjNZzTwgrDyFW5OQhI2PhFiYuc8Y5pblB+xeXuQV09c/0yUv2NH35tCwMwqzdnoNj9NdJe4/PaiPWcRm2FDPG8tNxe2WuU4qwV+mjTqsxa8c= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1570469275; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:To:ARC-Authentication-Results; bh=skx2g5tzDGItZR8vH7RW1H318T3vn9ZFfSKlH7uJWZU=; b=dQSbkxVCWt6D9sk4C2zMzFW75krZ497trhypPd1O2/dkB5nBWZWzDOQaaNEf9a01UMhW6BuDfapCCsZ2MS9yrqnPBF8Zrf/nZG6nvAwwKF3zHn1Nfq8E/tK6Id/Hi+cYl65hxhUONLyLyihOVZkk8UrCOBL4tLXToRxP2epS+k0= ARC-Authentication-Results: i=1; mx.zoho.com; dkim=pass header.i=topbug.net; spf=pass smtp.mailfrom=hong@topbug.net; dmarc=pass header.from= header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1570469275; s=zoho; d=topbug.net; i=hong@topbug.net; h=Subject:To:Cc:References:From:Message-ID:Date:MIME-Version:In-Reply-To:Content-Type:Content-Transfer-Encoding; l=1101; bh=skx2g5tzDGItZR8vH7RW1H318T3vn9ZFfSKlH7uJWZU=; b=VeR1qhfSWfdCH5IHWsj9r7wWEGUH/fTLMvPxDr2A68UgFzK1ZujMxY7LMbuuN+eC dFcIQxcQXXDYI5b3H5NS4mQ0kAbcAZmz81CTAaWRfqaxFM5RTnjTu5BqtjTzbB2QJcr IpI5K3eWMSEwKLlB0+hoy/KP+GHqlHR1JV8gobNw= Original-Received: from [192.168.88.88] (69-215-149-151.lightspeed.sntcca.sbcglobal.net [69.215.149.151]) by mx.zohomail.com with SMTPS id 1570469273512294.77554732281294; Mon, 7 Oct 2019 10:27:53 -0700 (PDT) Openpgp: preference=signencrypt In-Reply-To: <83y2xwzfz0.fsf@gnu.org> Content-Language: en-US X-ZohoMailClient: External 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:168560 Archived-At: On 10/7/19 9:18 AM, Eli Zaretskii wrote: >> From: Lars Ingebrigtsen >> Cc: Eli Zaretskii , 37538@debbugs.gnu.org >> Date: Mon, 07 Oct 2019 06:13:54 +0200 >> >> Hong Xu writes: >> >>> Please see my update below. I'm writing in this concise form because `(elisp) Programmed Completion' has a lot of explanation and I don't think we should repeat them here. >> >> Looks good to me. I've now applied it to Emacs 27. > > The doc string talks about WHAT and refers to the ELisp manual, but > that node in the manual doesn't mention anything called WHAT. > Would the following docstring work for you (will be reformatted)? Because the function accepts the same arguments as the one documented in `(elisp) Programmed Completion', I thought it should be understandable that WHAT refers to the third argument. The meaning of the arguments are the same as the function form of COLLECTION as explained in Info node `(elisp) Programmed Completion', except that if the third parameter (WHAT) does not equal t, it is treated as if it were nil.