bug#49964: 28.0.50; ERC button to docu, again

bug#49964: 28.0.50; ERC button to docu, again

[Emanuel Berg via Bug reports for GNU Emacs, the Swiss army knife of text editors]

[-- Attachment #1: Type: text/plain, Size: 1117 bytes --]


I just wrote about this on
gmane.emacs.help/gmane.emacs.erc.general so I'll just reuse
that, I think it is clear what I mean :) Keep it up...

2. What is `this-convention' and ‘this‘? I always used
   `this-one' - I don't know/remember why, probably I saw
   someone else do it - but it seems in the on-line (*) help
   ‘this‘ is what happens, indeed even if you use
   `the-other-one' [see this example [1]]

3. In ERC, for example `sentence-end-double-space' gets turned
   into a button that opens up a help buffer, however with the
   other convention, i.e. ‘sentence-end-without-period’,
   nothing happens. maybe ‘this’ doesn't get
   highlighted/buttonized/hyperlinked because people use it
   for other things than to denote Emacs references?
   Emacs references? naah! Anyway here [2] is a screenshot [2]
   which is also attached to this post that shows what
   happens/how it looks.

(*) On-line help means it isn't on paper :)

[1] https://dataswamp.org/~incal/emacs-init/wrap-search.el
[2]
https://dataswamp.org/~incal/figures/emacs/erc-docu-button-again.png


[-- Attachment #2: erc-docu-button-again.png --]
[-- Type: image/png, Size: 8713 bytes --]

[-- Attachment #3: Type: text/plain, Size: 2558 bytes --]




In GNU Emacs 28.0.50 (build 2, x86_64-pc-linux-gnu)
 of 2021-08-02 built on ebih
Repository revision: 558065531beaaae78810508f267415c6953e8e47
Repository branch: master
System Description: Debian GNU/Linux 11 (bullseye)

Configured using:
 'configure --with-x-toolkit=no'

Configured features:
XPM JPEG TIFF GIF PNG SOUND DBUS GSETTINGS GLIB NOTIFY INOTIFY
LIBSELINUX GNUTLS LIBXML2 ZLIB OLDXMENU X11 XDBE XIM MODULES
THREADS PDUMPER

Important settings:
  value of $LANG: en_US.UTF-8
  locale-coding-system: utf-8-unix

Major mode: Group

Minor modes in effect:
  gnus-agent-group-mode: t
  async-bytecomp-package-mode: t
  erc-list-mode: t
  erc-menu-mode: t
  erc-networks-mode: t
  erc-track-mode: t
  erc-track-minor-mode: t
  erc-netsplit-mode: t
  cursor-sensor-mode: t
  show-paren-mode: t
  erc-match-mode: t
  erc-button-mode: t
  erc-ring-mode: t
  erc-pcomplete-mode: t
  erc-autojoin-mode: t
  erc-fill-mode: t
  erc-stamp-mode: t
  erc-irccontrols-mode: t
  erc-noncommands-mode: t
  erc-move-to-prompt-mode: t
  erc-readonly-mode: t
  erc-scrolltobottom-mode: t
  gnus-undo-mode: t
  shell-dirtrack-mode: t
  global-eldoc-mode: t
  electric-indent-mode: t
  mouse-wheel-mode: t
  tool-bar-mode: t
  global-font-lock-mode: t
  font-lock-mode: t
  auto-composition-mode: t
  auto-compression-mode: t
  buffer-read-only: t
  transient-mark-mode: t

Load-path shadows:
/home/incal/quicklisp/dists/quicklisp/software/slime-v2.26.1/slime hides /usr/share/emacs/site-lisp/elpa-src/slime-2.26.1/slime
/home/incal/quicklisp/dists/quicklisp/software/slime-v2.26.1/slime-autoloads hides /usr/share/emacs/site-lisp/elpa-src/slime-2.26.1/slime-autoloads
/home/incal/quicklisp/dists/quicklisp/software/slime-v2.26.1/slime-tests hides /usr/share/emacs/site-lisp/elpa-src/slime-2.26.1/slime-tests
~/.emacs.d/emacs-init/isbn-verify hides /home/incal/.emacs.d/elpa/isbn-verify-2.0.0/isbn-verify
~/.emacs.d/emacs-init/signal hides /home/incal/.emacs.d/elpa/signal-20160816.1438/signal
~/.emacs.d/lisp/abbrev hides /usr/local/share/emacs/28.0.50/lisp/abbrev
~/.emacs.d/emacs-init/misc hides /usr/local/share/emacs/28.0.50/lisp/misc

Features:
(shadow emacsbug dash double deuglify gnus-cus gnus-demon
gnus-diary nndiary gnus-draft gnus-fun gnus-html ...)

Memory information:
((conses 16 889516 222517)
 (symbols 48 55462 3)
 (strings 32 214482 21490)
 (string-bytes 1 8392181)
 (vectors 16 67730)
 (vector-slots 8 2064313 184854)
 (floats 8 529 486)
 (intervals 56 137635 7886)
 (buffers 992 203))

-- 
underground experts united
https://dataswamp.org/~incal

bug#49964: 28.0.50; ERC button to docu, again

[Lars Ingebrigtsen]

Emanuel Berg <moasenwood@zoho.eu> writes:

> I just wrote about this on
> gmane.emacs.help/gmane.emacs.erc.general so I'll just reuse
> that, I think it is clear what I mean :) Keep it up...
>
> 2. What is `this-convention' and ‘this‘? I always used
>    `this-one' - I don't know/remember why, probably I saw
>    someone else do it - but it seems in the on-line (*) help
>    ‘this‘ is what happens, indeed even if you use
>    `the-other-one' [see this example [1]]

What do you mean by `this-convention'?  I can't find that string in the
Emacs tree.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#49964: 28.0.50; ERC button to docu, again

[Emanuel Berg via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Lars Ingebrigtsen wrote:

>> I just wrote about this on
>> gmane.emacs.help/gmane.emacs.erc.general so I'll just reuse
>> that, I think it is clear what I mean :) Keep it up...
>>
>> 2. What is `this-convention' and ‘this‘? I always used
>>    `this-one' - I don't know/remember why, probably I saw
>>    someone else do it - but it seems in the on-line (*) help
>>    ‘this‘ is what happens, indeed even if you use
>>    `the-other-one' [see this example [1]]
>
> What do you mean by `this-convention'? I can't find that
> string in the Emacs tree.

Do

  $ emacs -Q test.el

and type `kill-emacs' and see what happens.

It gets buttonized to the help if used in ERC, I think that's
cool and helpful as well, for example in #emacs.

In the Emacs help tho it gets buttonized/hyperlinked as well
but converted to (respelled as) ‘kill-emacs‘, even if put as
`kill-emacs' in a docstring.

That notation, i.e. ‘kill-emacs‘, however does not get
highlighted/buttonized/hyperlinked in ERC, I don't know if
that is by intent.

Again take a look at the screenshot to see what happens:

  https://dataswamp.org/~incal/figures/emacs/erc-docu-button-again.png

-- 
underground experts united
https://dataswamp.org/~incal

bug#49964: 28.0.50; ERC button to docu, again

[Lars Ingebrigtsen]

Emanuel Berg via "Bug reports for GNU Emacs, the Swiss army knife of
text editors" <bug-gnu-emacs@gnu.org> writes:

> Do
>
>   $ emacs -Q test.el
>
> and type `kill-emacs' and see what happens.

Oh, you mean the convention we use for quoting Lisp symbols?

> It gets buttonized to the help if used in ERC, I think that's
> cool and helpful as well, for example in #emacs.
>
> In the Emacs help tho it gets buttonized/hyperlinked as well
> but converted to (respelled as) ‘kill-emacs‘, even if put as
> `kill-emacs' in a docstring.
>
> That notation, i.e. ‘kill-emacs‘, however does not get
> highlighted/buttonized/hyperlinked in ERC, I don't know if
> that is by intent.

So the request is to have Lisp symbols with "pretty quotes" be
buttonised in erc?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no

bug#49964: 28.0.50; ERC button to docu, again

[Emanuel Berg via Bug reports for GNU Emacs, the Swiss army knife of text editors]

Lars Ingebrigtsen wrote:

> So the request is to have Lisp symbols with "pretty quotes"
> be buttonised in erc?

Well, request and request, I just saw it and thought I'd tell
you about it.

It seems in Elisp and ERC `kill-emacs' is the sanctioned
way, in the help system and in info it is ‘kill-emacs’.

If both are official then it makes sense ‘kill-emacs’ is
buttonized to, the possible counter-argument I could think of
is that people use it in normal language so one would have
false hits. Personally tho I don't even know how to type it...

The opening char is a LEFT SINGLE QUOTATION MARK and the
closing one RIGHT SINGLE QUOTATION MARK.

-- 
underground experts united
https://dataswamp.org/~incal

bug#49964: 28.0.50; ERC button to docu, again

[Stefan Kangas]

tags 49964 fixed
close 49964 28.1
thanks

Emanuel Berg <moasenwood@zoho.eu> writes:

> Lars Ingebrigtsen wrote:
>
>> So the request is to have Lisp symbols with "pretty quotes"
>> be buttonised in erc?
>
> Well, request and request, I just saw it and thought I'd tell
> you about it.
>
> It seems in Elisp and ERC `kill-emacs' is the sanctioned
> way, in the help system and in info it is ‘kill-emacs’.
>
> If both are official then it makes sense ‘kill-emacs’ is
> buttonized to, the possible counter-argument I could think of
> is that people use it in normal language so one would have
> false hits. Personally tho I don't even know how to type it...
>
> The opening char is a LEFT SINGLE QUOTATION MARK and the
> closing one RIGHT SINGLE QUOTATION MARK.

I have now fixed this on (commit 2d97b1ef5b).  This change will be a
part of the upcoming Emacs 28.1.

Please verify that this fix works for you, but for now I'm closing this
bug report.  If you see anything that is wrong, please reply to this
email (use "Reply to all" in your email client) and we can reopen the
bug report.  You could also just report a new bug.

Thanks again for the bug report!