From: Eli Zaretskii <eliz@gnu.org>
To: Andrew Burgess <aburgess@redhat.com>
Cc: gdb-patches@sourceware.org
Subject: Re: [PATCH] gdb/python: allow Value.format_string to return styled output
Date: Mon, 07 Feb 2022 15:25:12 +0200 [thread overview]
Message-ID: <83iltqyfk7.fsf@gnu.org> (raw)
In-Reply-To: <20220207100533.GE2706@redhat.com> (message from Andrew Burgess on Mon, 7 Feb 2022 10:05:33 +0000)
> Date: Mon, 7 Feb 2022 10:05:33 +0000
> From: Andrew Burgess <aburgess@redhat.com>
> Cc: gdb-patches@sourceware.org
>
> Hi Eli,
>
> Didn't know if you wanted to give this patch a docs review or not.
Sorry I missed that.
> > +@item styling
> > +@code{True} if @value{GDBN} should apply styling to the returned
> > +string. When styling is applied, the returned string might contain
> > +ANSI terminal escape sequences. Escape sequences will only be
> > +included if styling is turned on, @xref{Output Styling}.
^^^^^
Please use "@pxref" or "see @ref" here. @xref produces a capitalized
"Note", which is not appropriate in the middle of a sentence.
The documentation parts are OK with that nit fixed.
next prev parent reply other threads:[~2022-02-07 13:26 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-01-25 10:50 Andrew Burgess
2022-01-25 12:56 ` Simon Marchi
2022-01-25 16:07 ` Andrew Burgess
2022-01-25 16:27 ` Simon Marchi
2022-01-25 17:27 ` Andrew Burgess
2022-02-07 10:05 ` Andrew Burgess
2022-02-07 13:25 ` Eli Zaretskii [this message]
2022-02-07 17:03 ` Andrew Burgess
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=83iltqyfk7.fsf@gnu.org \
--to=eliz@gnu.org \
--cc=aburgess@redhat.com \
--cc=gdb-patches@sourceware.org \
/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).