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: Hong Xu
Subject: bug#37538: [PATCH] Add docstring for `tags-complete-tags-table-file'.
Date: Fri, 11 Oct 2019 17:48:16 -0700
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:60.0) Gecko/20100101 Thunderbird/60.9.0

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 via email to

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