unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Hong Xu <hong@topbug.net>
To: Eli Zaretskii <eliz@gnu.org>
Cc: larsi@gnus.org, 37538@debbugs.gnu.org
Subject: bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file'.
Date: Fri, 11 Oct 2019 17:48:16 -0700	[thread overview]
Message-ID: <6ade514f-53ee-fbbf-bf27-e8bbfb2e6281@topbug.net> (raw)
In-Reply-To: <831rvlt4yk.fsf@gnu.org>

On 10/10/19 12:49 AM, Eli Zaretskii wrote:
>> Cc: larsi@gnus.org, 37538@debbugs.gnu.org
>> From: Hong Xu <hong@topbug.net>
>> 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 copy so much text over here to the docstring, plus there are additional reference in the referred manual section.
> 
> If you show me what long description you had in mind, I could try
> saying that more concisely as appropriate for a doc string.
> 

This snippet in Programmed Completion section:

    • 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.

      ‘nil’
           This specifies a ‘try-completion’ operation.  The function
           should return ‘nil’ if there are no matches; it should return
           ‘t’ if the specified string is a unique and exact match; and
           it should return the longest common prefix substring of all
           matches otherwise.

      ‘t’
           This specifies an ‘all-completions’ operation.  The function
           should return a list of all possible completions of the
           specified string.

      [other kinds of values]







  reply	other threads:[~2019-10-12  0:48 UTC|newest]

Thread overview: 15+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-09-28  7:59 bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file' Hong Xu
2019-09-28  8:11 ` Eli Zaretskii
2019-09-28 18:40   ` Hong Xu
2019-10-07  4:13     ` Lars Ingebrigtsen
2019-10-07 16:18       ` Eli Zaretskii
2019-10-07 17:27         ` Hong Xu
2019-10-08 16:21           ` Lars Ingebrigtsen
2019-10-09  6:39             ` Hong Xu
2019-10-09  8:09               ` Eli Zaretskii
2019-10-09 22:58                 ` Hong Xu
2019-10-10  7:49                   ` Eli Zaretskii
2019-10-12  0:48                     ` Hong Xu [this message]
2019-10-12  9:04                       ` Eli Zaretskii
2019-10-12 18:46                         ` Hong Xu
2019-10-12 18:57                           ` Eli Zaretskii

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.gnu.org/software/emacs/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=6ade514f-53ee-fbbf-bf27-e8bbfb2e6281@topbug.net \
    --to=hong@topbug.net \
    --cc=37538@debbugs.gnu.org \
    --cc=eliz@gnu.org \
    --cc=larsi@gnus.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).