[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <d8b359ff-5891-7bb8-d292-9f10cca04f17@amd.com>
Date: Mon, 24 Jun 2019 20:06:00 +0000
From: Gary R Hook <ghook@....com>
To: Joe Perches <joe@...ches.com>, "Hook, Gary" <Gary.Hook@....com>,
"herbert@...dor.apana.org.au" <herbert@...dor.apana.org.au>,
"corbet@....net" <corbet@....net>,
"linux-doc@...r.kernel.org" <linux-doc@...r.kernel.org>,
"linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
"linux-crypto@...r.kernel.org" <linux-crypto@...r.kernel.org>,
"davem@...emloft.net" <davem@...emloft.net>
Subject: Re: [PATCH 0/3] Clean up crypto documentation
On 6/24/19 2:30 PM, Joe Perches wrote:
> On Mon, 2019-06-24 at 19:07 +0000, Hook, Gary wrote:
>> Tidy up the crypto documentation by filling in some variable
>> descriptions, make some grammatical corrections, and enhance
>> formatting.
>
> While this seems generally OK, please try not to make the
> readability of the source _text_ less intelligible just
> to enhance the output formatting of the html.
>
> e.g.:
>
> Unnecessary blank lines separating function descriptions
> Removing space alignment from bullet point descriptions
Apologies. I generally consider white space a Good Thing,
but will take your note and not do that. The blank lines I
added do not affect the output, so I should not have done
that.
Also, I turned sentences into bulleted lists here, so I'm not
clear on whether that was a Bad Thing or not. Seems more legible
to me all the way around, but I clearly could be incorrect. I
agree that mucking with alignment is a bad thing, and would not
intentionally do so. That said, if you would please elaborate on
any mistakes I've made?
Finally, would you prefer a v2 of the patch set? Happy to do
whatever is preferred, of course.
grh
Powered by blists - more mailing lists