From: Felipe Contreras <felipe.contreras@gmail.com>
To: "brian m. carlson" <sandals@crustytoothpaste.net>,
"Ævar Arnfjörð Bjarmason" <avarab@gmail.com>
Cc: Felipe Contreras <felipe.contreras@gmail.com>,
git@vger.kernel.org, Junio C Hamano <gitster@pobox.com>,
"Randall S. Becker" <rsbecker@nexbridge.com>
Subject: Re: [PATCH] help: colorize man pages
Date: Wed, 19 May 2021 21:45:18 -0500 [thread overview]
Message-ID: <60a5cd3ed5aaf_1e275208a0@natae.notmuch> (raw)
In-Reply-To: <YKXBdQ36MYz2YG8s@camp.crustytoothpaste.net>
brian m. carlson wrote:
> On 2021-05-19 at 09:26:12, Ævar Arnfjörð Bjarmason wrote:
> >
> > On Tue, May 18 2021, brian m. carlson wrote:
> >
> > > Would you consider various projects coloring their respective manual
> > > pages differently to be a desirable state of affairs?
> >
> > I think it's an important distinction that we're not coloring any manual
> > pages, it's a question of whether we invoke "man" invoked by "git help
> > <whatever>" with the exact same paramaters/options a user would get with
> > "man git-<whatever>".
>
> Yes. I would expect that if the man option is chosen, then we invoke
> man without modification.
Do you also expect git to call diff without options?
> The documentation says, "use the man program as usual". "As usual"
> implies the way the user would invoke it.
The documentation can be updated.
> > I don't think it's confusing in that context if we learn to do some "man
> > with fancy on top" in this mode.
> It's pretty obvious that "git help commit" and "cargo help build" both
> are intended to invoke man when used in the normal way.
And I don't.
I expect the output `foo help $x` to be decided by foo.
If I do `python help len` and I get an error, that's fine.
> > But if colors only add, but don't substract information by default
> > that's not an issue for the color blind, correct? Or at least that's
> > been my understanding in helping color blind user in the past (and not
> > being color blind myself).
>
> The problem becomes if the color is indistinguishable from other
> elements.
It is not indistiguishable; a blind person would be able to distinguish
them. As much as they can without the patch.
> It is _also_ a problem if we have two colors with sufficient contrast
> between the foreground and background but those colors look the same and
> there is no other distinguishing factor.
There is another distinguising factor: they are *bold*, or _underlined_.
> So, yes, if the colors only add information and they can otherwise be
> distinguished, then it's fine.
We are setting *bold*, _underlined_, and REVERSE.
Exactly in the same way as they are set already.
A truly colorblind person would see no difference at all.
> What I don't like is when a program colors text in a certain way, I
> can't read it, and then I can't read the help output or documentation to
> turn it off.
If you can't read `man git`, that has absolutely nothing to do with this
patch.
> I am specifically arguing against coloring our documentation
We already already coloring our documentation.
> and help output because it leaves users with little recourse to fix
> the problem.
man git.
--
Felipe Contreras
next prev parent reply other threads:[~2021-05-20 2:45 UTC|newest]
Thread overview: 33+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-05-18 1:01 [PATCH] help: colorize man pages Felipe Contreras
2021-05-18 1:19 ` brian m. carlson
2021-05-18 3:22 ` Felipe Contreras
2021-05-18 23:49 ` brian m. carlson
2021-05-19 1:08 ` Junio C Hamano
2021-05-19 2:07 ` brian m. carlson
2021-05-19 6:09 ` Junio C Hamano
2021-05-19 8:41 ` Ævar Arnfjörð Bjarmason
2021-05-19 10:36 ` Felipe Contreras
2021-05-21 0:58 ` brian m. carlson
2021-05-21 18:09 ` Felipe Contreras
2021-05-21 19:48 ` Igor Djordjevic
2021-05-21 21:20 ` Felipe Contreras
2021-05-21 22:10 ` Igor Djordjevic
2021-05-21 23:04 ` Felipe Contreras
2021-05-22 18:38 ` Igor Djordjevic
2021-05-22 21:48 ` Felipe Contreras
2021-05-23 11:25 ` Igor Djordjevic
2021-05-23 14:48 ` Felipe Contreras
2021-05-21 22:47 ` Igor Djordjevic
2021-05-21 23:32 ` Junio C Hamano
2021-05-19 9:26 ` Ævar Arnfjörð Bjarmason
2021-05-19 10:10 ` Jeff King
2021-05-19 11:45 ` Felipe Contreras
2021-05-19 11:19 ` Felipe Contreras
2021-05-19 12:21 ` Felipe Contreras
2021-05-20 1:55 ` brian m. carlson
2021-05-20 2:23 ` Junio C Hamano
2021-05-20 3:05 ` Felipe Contreras
2021-05-20 3:28 ` Junio C Hamano
2021-05-20 3:48 ` Felipe Contreras
2021-05-20 2:45 ` Felipe Contreras [this message]
2021-05-19 10:25 ` Felipe Contreras
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
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=60a5cd3ed5aaf_1e275208a0@natae.notmuch \
--to=felipe.contreras@gmail.com \
--cc=avarab@gmail.com \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=rsbecker@nexbridge.com \
--cc=sandals@crustytoothpaste.net \
/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.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
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).