Re: [PATCH 1/2] Documentation: sphinx: Add sphinx-prompt

From: Jonathan Corbet
Date: Mon Aug 28 2023 - 11:13:15 EST


Matthew Wilcox <willy@xxxxxxxxxxxxx> writes:

> On Mon, Aug 28, 2023 at 07:41:39AM -0600, Jonathan Corbet wrote:
>> I appreciate attempts to improve our documentation, and hope that you
>> will continue to do so. I am far from convinced, though, that this
>> change clears the bar for mainline inclusion.
>
> I'd ask that you reconsider. Looking at patch 2, I prefer what is
> written there. I don't think it adds cognitive load when reading the
> plain docs. I find the "copy and paste from html" argument not very
> convincing, but I do like "copy and paste from rst", which this enables.

Do you really think that the benefit from that justifies adding a build
dependency and breaking everybody's docs build until they install it? I
rather suspect I would hear back from people who feel otherwise if I did
that...

> I also have a certain fond memory of how the plan9 people set up 'rc'
> (their shell) so that ";" was both an empty statement, and the default
> prompt. So you could copy-paste lines starting with the ; prompt and
> they'd work. It's a small usabillity improvement, but it is there,
> and wow is it annoying when you don't have it any more.

Ah, OK, so what we really need is a bash patch :)

Thanks,

jon