public inbox for gdb-patches@sourceware.org
 help / color / mirror / Atom feed
From: Eli Zaretskii <eliz@gnu.org>
To: Andrei Pikas <gdb@mail.api.win>
Cc: gdb-patches@sourceware.org, gdb@mail.api.win
Subject: Re: [PATCH v5] Add an option with a color type.
Date: Sun, 16 Oct 2022 19:22:52 +0300	[thread overview]
Message-ID: <83edv74u1v.fsf@gnu.org> (raw)
In-Reply-To: <20221016160354.30740-1-gdb@mail.api.win> (message from Andrei Pikas on Sun, 16 Oct 2022 19:03:54 +0300)

> From: Andrei Pikas <gdb@mail.api.win>
> Cc: eliz@gnu.org,
> 	Andrei Pikas <gdb@mail.api.win>
> Date: Sun, 16 Oct 2022 19:03:54 +0300
> 
> +@deffn {Scheme Procedure} color-escape-sequence color is_foreground
> +Return string to change terminal's color to this.
> +
> +@var{is_foreground} If @var{is_foreground} is @code{#t}, then the returned
   ^^^^^^^^^^^^^^^^^^^^
I believe the underlined part should be deleted.

> +sequence will change foreground color. Otherwise, the returned sequence will
                                        ^^
Two spaces between sentences, please.

> +@defun Color.escape_sequence (@var{self}, @var{is_foreground})
> +Returns string to change terminal's color to this.
> +
> +@var{is_foreground} If @var{is_foreground} is @code{True}, then the returned
> +sequence will change foreground color. Otherwise, the returned sequence will
> +change background color.
> +@end defun

Same here.

The documentation parts are okay when these nits are fixed.

Thanks.

  reply	other threads:[~2022-10-16 16:23 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-10-16 11:40 [PATCH v4] " Andrei Pikas
2022-10-16 13:45 ` Eli Zaretskii
2022-10-16 16:03   ` [PATCH v5] " Andrei Pikas
2022-10-16 16:22     ` Eli Zaretskii [this message]
2022-10-16 16:28       ` [PATCH v6] " Andrei Pikas
2022-10-16 16:45         ` Eli Zaretskii
2024-04-19 19:33         ` Tom Tromey
2024-04-19 19:52           ` Andrei Pikas
2024-04-19 20:19             ` Tom Tromey
2024-04-20 18:24               ` Tom Tromey
2024-04-20 18:32                 ` Andrei Pikas
2024-05-11 15:17                 ` Andrei Pikas
2024-05-13 19:02                   ` Tom Tromey
2024-05-21  9:00                     ` Andrei Pikas

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=83edv74u1v.fsf@gnu.org \
    --to=eliz@gnu.org \
    --cc=gdb-patches@sourceware.org \
    --cc=gdb@mail.api.win \
    /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).