GNU bug report logs - #32248
(emacs) `Indentation Commands': Bad formatting

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 32248 in the body.
You can then email your comments to 32248 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Drew Adams <drew.adams <at> oracle.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 27.0; (elisp) `Indentation Commands': Bad formatting
Date: Sun, 22 Jul 2018 18:36:57 -0700 (PDT)

Some of the key descriptions do not use the correct font: <TAB>, <LEFT>,
and <RIGHT>.

You can see this more easily in the HTML version:
https://www.gnu.org/software/emacs/manual/html_node/emacs/Indentation-Commands.html

In GNU Emacs 27.0.50 (build 3, x86_64-w64-mingw32)
 of 2018-03-21
Repository revision: e70d0c9e66d7a8609450b2889869d16aeb0363b5
Windowing system distributor `Microsoft Corp.', version 6.1.7601
Configured using:
 `configure --without-dbus --host=x86_64-w64-mingw32
 --without-compress-install -C 'CFLAGS=-O2 -static -g3''

Message #8 received at 32248 <at> debbugs.gnu.org (full text, mbox):

From: Noam Postavsky <npostavs <at> gmail.com>
To: Drew Adams <drew.adams <at> oracle.com>
Cc: 32248 <at> debbugs.gnu.org
Subject: Re: bug#32248: 27.0; (elisp) `Indentation Commands': Bad formatting
Date: Tue, 24 Jul 2018 22:13:50 -0400

retitle 32248 (emacs) `Indentation Commands': Bad formatting
severity 32248 minor
quit

Drew Adams <drew.adams <at> oracle.com> writes:

> Some of the key descriptions do not use the correct font: <TAB>, <LEFT>,
> and <RIGHT>.
>
> You can see this more easily in the HTML version:
> https://www.gnu.org/software/emacs/manual/html_node/emacs/Indentation-Commands.html

The corresponding texinfo source has:

    adjusting the indentation of the affected lines interactively.  While
    this transient mode is active, typing @key{LEFT} or @key{RIGHT}
    indents leftward and rightward, respectively, by one space.  You can
    also type @kbd{S-@key{LEFT}} or @kbd{S-@key{RIGHT}} to indent leftward

It seems that @key{} by itself just puts angle brackets around the key,
without changing font.  @kbd{} translates into <kbd> tags.  So I think
the formatting is as intended.

Message #17 received at 32248-done <at> debbugs.gnu.org (full text, mbox):

From: Eli Zaretskii <eliz <at> gnu.org>
To: Noam Postavsky <npostavs <at> gmail.com>
Cc: 32248-done <at> debbugs.gnu.org, drew.adams <at> oracle.com
Subject: Re: bug#32248: 27.0; (elisp) `Indentation Commands': Bad formatting
Date: Wed, 25 Jul 2018 17:26:31 +0300

> From: Noam Postavsky <npostavs <at> gmail.com>
> Date: Tue, 24 Jul 2018 22:13:50 -0400
> Cc: 32248 <at> debbugs.gnu.org
> 
> The corresponding texinfo source has:
> 
>     adjusting the indentation of the affected lines interactively.  While
>     this transient mode is active, typing @key{LEFT} or @key{RIGHT}
>     indents leftward and rightward, respectively, by one space.  You can
>     also type @kbd{S-@key{LEFT}} or @kbd{S-@key{RIGHT}} to indent leftward
> 
> It seems that @key{} by itself just puts angle brackets around the key,
> without changing font.  @kbd{} translates into <kbd> tags.  So I think
> the formatting is as intended.

Yes, it's what the author intended.  Whether to use @kbd{@key{...}} or
just @key{...} is many times a judgment call, and this case is
borderline.  However, given that some of the keys in this node are
inside @kbd and some not, and they are so close to each other within
the same text, I think it is better to have them all in @kbd.  So I
made that change, and I'm marking this bug done.

Thanks.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.