From: "João Távora" <joaotavora@gmail.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: thievol@posteo.net, rms@gnu.org, 59082@debbugs.gnu.org
Subject: bug#59082: 28.2; Undocumented `intern-soft` feature with shorthands symbols
Date: Mon, 14 Nov 2022 13:36:15 +0000 [thread overview]
Message-ID: <CALDnm50hq85E63ibaFCLm3q7DheTPu+bSFVPCnNUdfF_KfPZtg@mail.gmail.com> (raw)
In-Reply-To: <83leodk7oi.fsf@gnu.org>
[-- Attachment #1: Type: text/plain, Size: 1686 bytes --]
On Mon, Nov 14, 2022 at 1:05 PM Eli Zaretskii <eliz@gnu.org> wrote:
> I think it really is such a widespread (and good) practice to include
> cross-references in doc strings that it should be a no-brainer to
> decide that supporting this practice is important.
>
OK, are these the only examples? Because my brain also tells me
that these could be fixed by hand, for example:
-previously found match, use `s-count-matches'."
+previously found match, use `magnars-string-count-matches'."
Of course, I agree that if we have this support in the docstring
logic, it is more convenient to _not_ have to do this edit.
Anyway, I hope everyone here is on the same page that
whatever the implementation of that support is, when typing
C-h f s-count-matches OR C-h f magnars-string-count-matches
in a buffer where read-symbol-shorthands is non-nil, then what appears
in the subsequent _global_ *Help* buffer is sth like:
magnars-string-count-matches-all is a function defined in
magnars-string.el
Blabla... see, also magnars-string-count-matches.
I.e. the name of the symbol is `magnars-string-count-matches`,
not `s-count-matches`: that's just a local shorthand in that particular
hypothetical buffer (the local shorthand s- being particularly popular
for the library in question).
IOW it would be plainly wrong to print the symbol as s-count-matches
in the *Help* buffer. Even though that's a popular shorthand, another
buffer where `s-` is already taken for `sandworms-` might have decided
to use the shorthand `str-` instead for `magnar-string.el`
I know I keep reminding this, I just want to make sure everyone
understands this.
João
[-- Attachment #2: Type: text/html, Size: 2353 bytes --]
next prev parent reply other threads:[~2022-11-14 13:36 UTC|newest]
Thread overview: 17+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-11-06 20:16 bug#59082: 28.2; Undocumented `intern-soft` feature with shorthands symbols Thierry Volpiatto
2022-11-12 12:42 ` Eli Zaretskii
2022-11-12 13:22 ` João Távora
2022-11-12 16:06 ` Thierry Volpiatto
2022-11-12 16:46 ` João Távora
2022-11-12 16:47 ` João Távora
2022-11-12 17:01 ` Eli Zaretskii
2022-11-12 17:18 ` João Távora
2022-11-12 17:49 ` Eli Zaretskii
2022-11-12 18:14 ` João Távora
2022-11-14 3:13 ` Richard Stallman
2022-11-14 6:39 ` João Távora
2022-11-14 13:11 ` Eli Zaretskii
2022-11-14 13:38 ` João Távora
2022-11-14 13:05 ` Eli Zaretskii
2022-11-14 13:36 ` João Távora [this message]
2022-11-14 13:56 ` 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=CALDnm50hq85E63ibaFCLm3q7DheTPu+bSFVPCnNUdfF_KfPZtg@mail.gmail.com \
--to=joaotavora@gmail.com \
--cc=59082@debbugs.gnu.org \
--cc=eliz@gnu.org \
--cc=rms@gnu.org \
--cc=thievol@posteo.net \
/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).