From mboxrd@z Thu Jan 1 00:00:00 1970 Path: news.gmane.io!.POSTED.blaine.gmane.org!not-for-mail From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Newsgroups: gmane.emacs.bugs Subject: bug#59082: 28.2; Undocumented `intern-soft` feature with shorthands symbols Date: Mon, 14 Nov 2022 13:36:15 +0000 Message-ID: References: <875yfresq9.fsf@posteo.net> <831qq8ny2m.fsf@gnu.org> <87leog4018.fsf@posteo.net> <83o7tcm7ji.fsf@gnu.org> <83mt8wm5ai.fsf@gnu.org> <83leodk7oi.fsf@gnu.org> Mime-Version: 1.0 Content-Type: multipart/alternative; boundary="00000000000004d13405ed6e4f70" Injection-Info: ciao.gmane.io; posting-host="blaine.gmane.org:116.202.254.214"; logging-data="11514"; mail-complaints-to="usenet@ciao.gmane.io" Cc: thievol@posteo.net, rms@gnu.org, 59082@debbugs.gnu.org To: Eli Zaretskii Original-X-From: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Tue Nov 15 00:33:55 2022 Return-path: Envelope-to: geb-bug-gnu-emacs@m.gmane-mx.org Original-Received: from lists.gnu.org ([209.51.188.17]) by ciao.gmane.io with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.92) (envelope-from ) id 1ouixf-0002nm-5c for geb-bug-gnu-emacs@m.gmane-mx.org; Tue, 15 Nov 2022 00:33:55 +0100 Original-Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ouilF-0005tj-Ar; Mon, 14 Nov 2022 18:21:05 -0500 Original-Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ouifP-0004p5-Az for bug-gnu-emacs@gnu.org; Mon, 14 Nov 2022 18:15:04 -0500 Original-Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1ouZd4-0007wK-8G for bug-gnu-emacs@gnu.org; Mon, 14 Nov 2022 08:36:02 -0500 Original-Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1ouZd3-00009p-PY for bug-gnu-emacs@gnu.org; Mon, 14 Nov 2022 08:36:01 -0500 X-Loop: help-debbugs@gnu.org Resent-From: =?UTF-8?Q?Jo=C3=A3o_?= =?UTF-8?Q?T=C3=A1vora?= Original-Sender: "Debbugs-submit" Resent-CC: bug-gnu-emacs@gnu.org Resent-Date: Mon, 14 Nov 2022 13:36:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 59082 X-GNU-PR-Package: emacs Original-Received: via spool by 59082-submit@debbugs.gnu.org id=B59082.1668432919557 (code B ref 59082); Mon, 14 Nov 2022 13:36:01 +0000 Original-Received: (at 59082) by debbugs.gnu.org; 14 Nov 2022 13:35:19 +0000 Original-Received: from localhost ([127.0.0.1]:49146 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ouZcN-00008v-9N for submit@debbugs.gnu.org; Mon, 14 Nov 2022 08:35:19 -0500 Original-Received: from mail-oa1-f51.google.com ([209.85.160.51]:36782) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1ouZcL-00008f-5Z for 59082@debbugs.gnu.org; Mon, 14 Nov 2022 08:35:17 -0500 Original-Received: by mail-oa1-f51.google.com with SMTP id 586e51a60fabf-13bef14ea06so12478941fac.3 for <59082@debbugs.gnu.org>; Mon, 14 Nov 2022 05:35:17 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=I4fIa+D0SZ7QMo4IrdP1XMzlHc0q65X7WKFsMyB/5NQ=; b=nNf8j30WuIc4Ygn2sSnz+3wXEy85MdthDCt22L7FYnyusRhh+lXXKWd5bmj/eqmwV6 G51ROXYZ/hyCe1yzLAIkBkiIel27EIG415UEZPxGJka7FqF1nRQRKKrJIJac67yWiKXC zQuCHeivJZWbi9ScLSsZekt8pb9biGKemRmNTNaUx9dHKX7XQ2jeQskZIf1KooA/I7n2 1hJpRQbW8OQ1DMfqc4Vf5/RodXdSisJ7lS7HcsW+g3Hvs1KabIPMJQ9nM/nz3g4SoPsA w637XL7zHcaLBXs7vgmVhPlc9bzbVgkQFmbaNCfb8/EpFVBInYEgr8CBKhgMlITJmsFY QPDw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=I4fIa+D0SZ7QMo4IrdP1XMzlHc0q65X7WKFsMyB/5NQ=; b=arMZMzPP3/05hblgWHF1dHXQj+XJpaC+tX/4wGW0qpUtrf3Vwpdc1N2T5c7jwQUo/K +ohXXDuJMIDC6Y1a699xt46VYU0WMph7nxGSCfMItwdv9kGX7ejH6aKHcRVpERI1Na5B ieiQOFebLC3rSe3uw0saEgNDmWutvlft5Z37OO8G6XrQVuDtGDFRrw9PuMzCSa03J3s3 K4mcjp1CvyhiizJzpjVPgxGkC/qwQJuBXCK+URzCb439jE1AAzlCXGifzSnB+gyPs4oF ID2npnWJ4RySVYvmDn3F5Jdcu+Lj8MGb62hsxXmB3r5u3kJd/bewPrJOcvSpox+AXISF BDfQ== X-Gm-Message-State: ANoB5pn3L1UFz0Lr0VPSOuviA4iwy46hILGkHWULYHpWy2UHu1K1iEDd 5KFOzJmqqbWLwPCdNYnY9e3w3zCvasm3iBA4L9c= X-Google-Smtp-Source: AA0mqf6f+Fb8K9Xd7afNWsbskSfn23k7K3GQOybdUOsV957MEy6fZsW4MEGpk5mKJjWibfN6kFdZbdPm7wpM2KEU6jE= X-Received: by 2002:a05:6871:b0e:b0:132:a103:ae22 with SMTP id fq14-20020a0568710b0e00b00132a103ae22mr6795782oab.215.1668432911453; Mon, 14 Nov 2022 05:35:11 -0800 (PST) In-Reply-To: <83leodk7oi.fsf@gnu.org> X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: bug-gnu-emacs@gnu.org List-Id: "Bug reports for GNU Emacs, the Swiss army knife of text editors" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Original-Sender: bug-gnu-emacs-bounces+geb-bug-gnu-emacs=m.gmane-mx.org@gnu.org Xref: news.gmane.io gmane.emacs.bugs:247834 Archived-At: --00000000000004d13405ed6e4f70 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable On Mon, Nov 14, 2022 at 1:05 PM Eli Zaretskii 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=C3=A3o --00000000000004d13405ed6e4f70 Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
On Mon, Nov 14, 2022 at 1:05 PM Eli Zaret= skii <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 t= he docstring
logic, it is more convenient to _not_ have to do thi= s edit.

Anyway, I hope everyone here is on the sam= e page that
whatever the implementation of that support is, = when typing
C-h f s-count-matches OR C-h f magnars-string-co= unt-matches
in a buffer where read-symbol-shorthands is non-nil, = then what appears
in the subsequent _global_ *Help* buffer is sth= like:

=C2=A0 magnars-string-count-matches-all is = a function defined in magnars-string.el

=C2=A0 Bla= bla... see, also magnars-string-count-matches.

I.e. the name of the symbol is `magnars-string-count-matches`,
<= /div>
not `s-count-matches`: that's just a local shorthand in that = particular
hypothetical buffer (the local shorthand s- being part= icularly popular
for the library in question).
IOW it would be plainly wrong to print the symbol as s-count-ma= tches
in the *Help* buffer.=C2=A0 Even though that's a popula= r shorthand, another
buffer where `s-` is already taken for `sand= worms-` might have decided
to use the shorthand `str-` instead fo= r `magnar-string.el`

I know I keep reminding t= his, I just want to make sure everyone
understands this.
=

Jo=C3=A3o
--00000000000004d13405ed6e4f70--