From: "Basil L. Contovounesios" <contovob@tcd.ie>
To: Eli Zaretskii <eliz@gnu.org>
Cc: 41571@debbugs.gnu.org
Subject: bug#41571: 27.0.91; "(elisp) Interpolated Strings" is under "(elisp) Text"
Date: Thu, 28 May 2020 11:41:54 +0100 [thread overview]
Message-ID: <87zh9sfij1.fsf@tcd.ie> (raw)
In-Reply-To: <83d06osfyw.fsf@gnu.org> (Eli Zaretskii's message of "Thu, 28 May 2020 09:58:47 +0300")
Eli Zaretskii <eliz@gnu.org> writes:
>> From: "Basil L. Contovounesios" <contovob@tcd.ie>
>> Date: Thu, 28 May 2020 00:57:34 +0100
>>
>> The Elisp manual node "(elisp) Interpolated Strings", which documents
>> the function format-spec and is new in Emacs 27, is currently included
>> under "(elisp) Text", which opens with:
>>
>> This chapter describes the functions that deal with the text in a
>> buffer. Most examine, insert, or delete text in the current buffer,
>> often operating at point or on text adjacent to point. Many are
>> interactive. All the functions that change the text provide for undoing
>> the changes (*note Undo).
>>
>> I think a more appropriate location would be following "(elisp)
>> Formatting Strings", or at least under "(elisp) Strings and Characters".
>
> I agree, but can we please take this opportunity to improve that
> section? First, it uses passive tense too much for no real reason
> AFAICT. More importantly, the description of the feature is not clear
> enough. I had trouble understanding even the "trivial example" it
> shows, let alone all the rest. The very purpose of the feature is not
> really obvious after reading the text.
Sure, I'll give it a try, as I was already working on improving the
format-spec implementation and documentation on master.
While I'm at it, may I change the node name? Interpolating is the same
as formatting in this context, so the difference between the two nodes
is not clear to me. Perhaps something like:
* Formatting Custom Strings:: Formatting custom @code{format} specifications.
In fact, couldn't format-spec be documented alongside format and
format-message under "(elisp) Formatting Strings"? Or does format-spec
need its own node?
Just to recap: format-spec is like format, except it allows custom
%-sequence characters, such as %z, which are substituted in a similar
way to format's %s. A common use case is to allow users to customise
different output presented to them via custom format control strings.
Thanks,
--
Basil
next prev parent reply other threads:[~2020-05-28 10:41 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-27 23:57 bug#41571: 27.0.91; "(elisp) Interpolated Strings" is under "(elisp) Text" Basil L. Contovounesios
2020-05-28 6:58 ` Eli Zaretskii
2020-05-28 10:41 ` Basil L. Contovounesios [this message]
2020-05-28 11:33 ` Eli Zaretskii
2020-05-29 18:35 ` Basil L. Contovounesios
2020-05-29 19:41 ` Eli Zaretskii
2020-05-31 9:24 ` Basil L. Contovounesios
2020-05-31 16:03 ` Eli Zaretskii
2020-06-02 14:03 ` Basil L. Contovounesios
2020-06-02 16:56 ` Eli Zaretskii
2020-06-02 19:57 ` Basil L. Contovounesios
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=87zh9sfij1.fsf@tcd.ie \
--to=contovob@tcd.ie \
--cc=41571@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.