From: Jose A Ortega Ruiz <jao@gnu.org>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 58131@debbugs.gnu.org
Subject: bug#58131: [PATCH] docview: new customization options for imenu
Date: Wed, 28 Sep 2022 16:14:13 +0100 [thread overview]
Message-ID: <877d1n7cqi.fsf@mail.jao.io> (raw)
In-Reply-To: <83edvvinjk.fsf@gnu.org>
On Wed, Sep 28 2022, Eli Zaretskii wrote:
>> From: Jose A Ortega Ruiz <jao@gnu.org>
>> Cc: 58131@debbugs.gnu.org
>> Date: Wed, 28 Sep 2022 15:05:50 +0100
>>
>> >> +(defcustom doc-view-imenu-title-format "%t (%p)"
>> >> + "Format string for document section titles in imenu.
>> >> +
>> >> +The special markers '%t' and '%p' are replaced by the section
>> >> +title and page number in this format string, which uses
>> >> +`format-spec'.
>> >
>> > Will users immediately understand what you mean by "document section
>> > title" here? If no, perhaps a sentence explaining what that is would
>> > be beneficial.
>>
>> I would say they will: in the context of a docview imenu for a PDF
>> document, there's little else it could reasonably be. But i'm biased: do
>> you think otherwise?
>
> FWIW, I couldn't understand what that means.
>
> How does being in the context of docview imenu for a PDF document help
> understanding that here? "Document section title" is general enough
> terminology. Using a "construct state" here doesn't help, either.
To me, the context is that this is read by a user of the functionality,
wanting to fine-tune it (i rarely start exploring a functionality by
reading the docstring of one of its customizable variables).
Barring that: the Imenu section of the manual calls the items being
formatted here simply "definitions". If we assume that the user knows
about imenu in general, one could have:
"Format string for the imenu definitions extracted from documents."
Or, perhaps, trying to provide the missing context for not-yet-users:
"Format string for the section titles extracted by imenu from docview documents."
Any better?
>> >> +(defcustom doc-view-imenu-flatten nil
>> >> + "Whether to generate a flat list of sections instead of a nested tree."
>> >
>> > This doesn't mention imenu in the doc string; should it?
>>
>> Given that the name of the variable does, i think mentioning it would
>> just make that first sentence longer without adding too much
>> information. But again, as the implementor of the functionality,
>> everything feels "obvious" to me.
>
> My suggestion is
>
> Whether to flatten the list of sections in an imenu or show it nested.
Sounds better to me too, yes.
Thanks,
jao
--
Nothing so soothes our vanity as a display of greater vanity in
others; it makes us vain, in fact, of our modesty.
-Louis Kronenberger, writer (1904-1980)
next prev parent reply other threads:[~2022-09-28 15:14 UTC|newest]
Thread overview: 9+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-09-28 2:21 bug#58131: [PATCH] docview: new customization options for imenu Jose A Ortega Ruiz
2022-09-28 11:08 ` Lars Ingebrigtsen
2022-09-28 12:34 ` Eli Zaretskii
2022-09-28 14:05 ` Jose A Ortega Ruiz
2022-09-28 14:25 ` Eli Zaretskii
2022-09-28 15:14 ` Jose A Ortega Ruiz [this message]
2022-09-28 15:49 ` Eli Zaretskii
2022-09-28 15:55 ` Jose A Ortega Ruiz
2022-09-28 16:01 ` 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=877d1n7cqi.fsf@mail.jao.io \
--to=jao@gnu.org \
--cc=58131@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 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).