Re: [PATCH v2 2/3] bitmap-format.txt: fix some formatting issues

From: Abhradeep Chakraborty <chakrabortyabhradeep79@gmail.com>
Date: Jun 8, 2022, 15:40 UTC
Message-ID: <20220608154050.10278-1-chakrabortyabhradeep79@gmail.com>
In-Reply-To: <Yp+6WU+k2OwHDB1b@nand.local>

Taylor Blau <me@ttaylorr.com> wrote:

> Hmm. When I render the HTML for this page and view it in my browser, the
> removed blank lines makes the contents of the section "2-byte flags
> (network byte order)" run together, and I think it hurts readability
> IMHO.

Honestly I agree with you. I also felt the same but then I thought it is still better than the currently broken page.

> Is there a way to keep those line breaks without significantly
> reformatting the source of this file?

I have a limited knowledge on asciidoc. I removed those blank lines only because it generates weird html output. I didn't find any other way to fix that (with minimum source code changes).

> This isn't new from your patch, but I wonder if now is a good
> opportunity to make some light use of the formatting options that
> ASCIIDoc gives us to make the page read a little bit more easily when
> rendered as HTML.

Yeah, quite sensible. I will surely look for better way.

> I don't want to compromise too much on the readability of the .txt file,
> though, so if there isn't a good way to strike this balance, then I
> trust you and think we should leave it as you have modified things here.

This is one of the main reason why I removed those blank lines and other stuff. It is the minimum change to fix the html doc. But I will look more into it.

Thanks :)