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: Fri, 11 Oct 2019 17:48:16 -0700 Message-ID: <6ade514f-53ee-fbbf-bf27-e8bbfb2e6281@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> <860671c8-787c-512c-8df6-ea1d9dfc2f5b@topbug.net> <874l0j1a3j.fsf@gnus.org> <663aaf32-97c4-0723-1a30-a644938bd21f@topbug.net> <83a7aawdar.fsf@gnu.org> <831rvlt4yk.fsf@gnu.org> Mime-Version: 1.0 Content-Type: text/plain; charset=utf-8; format=flowed Content-Transfer-Encoding: quoted-printable Injection-Info: blaine.gmane.org; posting-host="blaine.gmane.org:195.159.176.226"; logging-data="118155"; 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: larsi@gnus.org, 37538@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane.org@gnu.org Sat Oct 12 02:49:12 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 1iJ5ao-000UZB-Nr for geb-bug-gnu-emacs@m.gmane.org; Sat, 12 Oct 2019 02:49:10 +0200 Original-Received: from localhost ([::1]:58040 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iJ5am-0004d1-W0 for geb-bug-gnu-emacs@m.gmane.org; Fri, 11 Oct 2019 20:49:09 -0400 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]:46722) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1iJ5ah-0004cg-57 for bug-gnu-emacs@gnu.org; Fri, 11 Oct 2019 20:49:04 -0400 Original-Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1iJ5ag-0000iK-2O for bug-gnu-emacs@gnu.org; Fri, 11 Oct 2019 20:49:03 -0400 Original-Received: from debbugs.gnu.org ([209.51.188.43]:51688) by eggs.gnu.org with esmtps (TLS1.0:RSA_AES_128_CBC_SHA1:16) (Exim 4.71) (envelope-from ) id 1iJ5af-0000i8-Vk for bug-gnu-emacs@gnu.org; Fri, 11 Oct 2019 20:49:02 -0400 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1iJ5af-0008Rf-RJ for bug-gnu-emacs@gnu.org; Fri, 11 Oct 2019 20:49:01 -0400 X-Loop: help-debbugs@gnu.org Resent-From: Hong Xu Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Sat, 12 Oct 2019 00:49:01 +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.157084131432416 (code B ref 37538); Sat, 12 Oct 2019 00:49:01 +0000 Original-Received: (at 37538) by debbugs.gnu.org; 12 Oct 2019 00:48:34 +0000 Original-Received: from localhost ([127.0.0.1]:60509 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iJ5aD-0008Qm-LX for submit@debbugs.gnu.org; Fri, 11 Oct 2019 20:48:33 -0400 Original-Received: from sender4-of-o54.zoho.com ([136.143.188.54]:21478) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1iJ5aC-0008Qd-2S for 37538@debbugs.gnu.org; Fri, 11 Oct 2019 20:48:32 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1570841298; cv=none; d=zoho.com; s=zohoarc; b=fOmggM0ZhFzqaqhzJQ6wLP3fbZgub2v/JsQqhknaFDj9qcnz//cDzlOtP1NH7Il/rN9dBODpx20vB0bfp+9/paIoCi+Z226jECkbEutEVzrp6nok/2uHK5VVIQcU0j/pOHuC5t+cfbGwRLKrn2U5OhB2ag8CWvijqdXaZxEHt9E= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zoho.com; s=zohoarc; t=1570841298; h=Content-Type:Content-Transfer-Encoding:Cc:Date:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:To; bh=eC5NP5Jr2tRf3RVOv12R3vJrktfJv2B7vu4gPVJ7UgA=; b=li9JAi0ixscOjOSAVuQFJ+ELY6BxtZ6DrGK7FsoEpW08RNNSvqPEWLqI+JWsDE7alwV0594500LXuGLMXBSG6jjpA9EwuH993eOHjEphazHBUDzkAfvnIkcsZGxOXN/ZZVNlE6G/q99EJzDEGRzokHNBpnr5as4ba3ewXrR0Jsg= 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=1570841298; 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=1517; bh=eC5NP5Jr2tRf3RVOv12R3vJrktfJv2B7vu4gPVJ7UgA=; b=djxyCOviqncznsbXMkvw+ntOu7iEbil4zvBLNVQanK6Y+tF+Xr5Wh68AgBfYQnHx kmzafhS/NT/YJRsJI5QDz0JoxmTbZCpzm/8LA8MyKI0IUpLUfc2upqHDOOI1nPi0bMG uBItldw4PJoTTn1mg33tPTBtjmLsH2A35Ata47nc= 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 1570841297468253.99808117169675; Fri, 11 Oct 2019 17:48:17 -0700 (PDT) Openpgp: preference=signencrypt In-Reply-To: <831rvlt4yk.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:169017 Archived-At: On 10/10/19 12:49 AM, Eli Zaretskii wrote: >> Cc: larsi@gnus.org, 37538@debbugs.gnu.org >> From: Hong Xu >> Date: Wed, 9 Oct 2019 15:58:46 -0700 >> >>> 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? >>> >> >> The description was quite long and I don't think it is justifiable to co= py so much text over here to the docstring, plus there are additional refer= ence in the referred manual section. >=20 > If you show me what long description you had in mind, I could try > saying that more concisely as appropriate for a doc string. >=20 This snippet in Programmed Completion section: =E2=80=A2 A flag specifying the type of completion operation to perform= ; see *note Basic Completion::, for the details of those operations. This flag may be one of the following values. =E2=80=98nil=E2=80=99 This specifies a =E2=80=98try-completion=E2=80=99 operation. Th= e function should return =E2=80=98nil=E2=80=99 if there are no matches; it = should return =E2=80=98t=E2=80=99 if the specified string is a unique and exac= t match; and it should return the longest common prefix substring of all matches otherwise. =E2=80=98t=E2=80=99 This specifies an =E2=80=98all-completions=E2=80=99 operation. = The function should return a list of all possible completions of the specified string. [other kinds of values]