From: Stefan Kangas <stefan@marxist.se>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 31962-done@debbugs.gnu.org
Subject: bug#31962: 27.0; imenu.el constructs - names and doc
Date: Sat, 19 Oct 2019 03:09:14 +0200 [thread overview]
Message-ID: <CADwFkmm65eeN+8Fb-cVRkfEzzRQawijxeeGW85TmXwdDNmPMtw@mail.gmail.com> (raw)
In-Reply-To: <21dc18b7-5951-431b-940b-ab7e56bf8226@default>
Eli Zaretskii <eliz@gnu.org> writes:
>> Date: Sun, 24 Jun 2018 18:51:23 -0700 (PDT)
>> From: Drew Adams <drew.adams@oracle.com>
>>
>> 1. `imenu--generic-function' should not have a double-hyphen in its
>> name. It is the main function in the library, and it is explicitly
>> referenced by multiple doc strings in the file
>
> As long as this function is not autoloaded, we have no unequivocal
> proof that it's the main function in the library. A function that is
> the workhorse of a library can legitimately be an internal function.
>
> I agree that this case is somewhat borderline, but I don't have enough
> time and energy to make the changes in the current system, because the
> problems it creates sound very minor to me.
>
> I made small fixes in 2 doc strings, but that's as far as I was
> prepared to go in this case.
>
>> including that of a user option
>> (`imenu-generic-skip-comments-and-strings') and that of the
>> principal configuration variable (`imenu-generic-expression'), which
>> is defined per mode.
>
> The doc string of imenu-generic-skip-comments-and-strings was one of
> those I changed.
>
>> 2. The doc string of `imenu--generic-function' says this, with zero
>> description of INDEX-NAME INDEX-POSITION FUNCTION and ARGUMENTS:
>>
>> The return value is an alist of the form
>> (INDEX-NAME . INDEX-POSITION)
>> or
>> (INDEX-NAME INDEX-POSITION FUNCTION ARGUMENTS...)
>> The return value may also consist of nested index alists like:
>> (INDEX-NAME . INDEX-ALIST)
>> depending on PATTERNS.
>>
>> Each of those pieces of the return value should be specified, not just
>> named.
>
> Not as long as this is an internal function.
>
>> 3. Similarly, other functions and variables should be renamed to use a
>> single, not a double, hyphen, starting with `imenu--sort-by-name' and
>> `imenu--index-alist'. I don't argue now that NO functions wnd variables
>> in the library should have names declaring that they are internal, but a
>> better judgment call is in order.
>
> Likewise.
It looks like Eli made the necessary changes above, and I see nothing
more to do here. I'm therefore closing this bug report. Please reopen
if that's incorrect.
Best regards,
Stefan Kangas
prev parent reply other threads:[~2019-10-19 1:09 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2018-06-25 1:51 bug#31962: 27.0; imenu.el constructs - names and doc Drew Adams
2018-06-30 9:28 ` Eli Zaretskii
2019-10-19 1:09 ` Stefan Kangas [this message]
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
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=CADwFkmm65eeN+8Fb-cVRkfEzzRQawijxeeGW85TmXwdDNmPMtw@mail.gmail.com \
--to=stefan@marxist.se \
--cc=31962-done@debbugs.gnu.org \
--cc=eliz@gnu.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 external index
https://git.savannah.gnu.org/cgit/emacs.git
https://git.savannah.gnu.org/cgit/emacs/org-mode.git
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.