From: Kevin Buettner <kevinb@redhat.com>
To: Eli Zaretskii <eliz@gnu.org>
Cc: gdb-patches@sourceware.org, Tom Tromey <tom@tromey.com>
Subject: Re: [PATCH] Normalize "on|off" text in manual
Date: Fri, 12 Apr 2024 10:04:37 -0700 [thread overview]
Message-ID: <20240412100437.74769227@f39-zbm-amd> (raw)
In-Reply-To: <8634s7c7vn.fsf@gnu.org>
On Sun, 31 Mar 2024 08:01:16 +0300
Eli Zaretskii <eliz@gnu.org> wrote:
> > From: Tom Tromey <tom@tromey.com>
> > Cc: Tom Tromey <tom@tromey.com>
> > Date: Sat, 30 Mar 2024 12:54:01 -0600
> >
> > While looking in the info manual, I noticed this:
> >
> > ‘set style enabled ‘on|off’’
> >
> > The styling looked weird here and in the source I saw it was written as:
> >
> > @item set style enabled @samp{on|off}
> >
> > I looked through the rest of the manual and found this same sort of
> > thing was written in a variety of styles.
> >
> > For this patch, I picked one way to write this and applied it to all
> > the instances.
>
> Thanks.
>
> I agree that we should be consistent. While using @r{..} for the
> brackets and "|" is probably rigorously correct, I think it is too
> much bother, and thus is likely not to be followed by many patches. I
> wonder whether we could use the simpler way: leave them alone, which
> will cause the entire "set style enabled on|off" have the @code
> markup, due to "@table @code". This will be easier to follow and
> easier to enforce. What do people think?
So long as the result in the manual looks okay, I'm in favor of simplicity.
Kevin
prev parent reply other threads:[~2024-04-12 17:04 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-03-30 18:54 Tom Tromey
2024-03-31 5:01 ` Eli Zaretskii
2024-04-12 17:04 ` Kevin Buettner [this message]
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=20240412100437.74769227@f39-zbm-amd \
--to=kevinb@redhat.com \
--cc=eliz@gnu.org \
--cc=gdb-patches@sourceware.org \
--cc=tom@tromey.com \
/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.
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).