[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH 1/2] docs: Fix botched rST conversion of 'submitting-a-patch.

From: Thomas Huth
Subject: Re: [PATCH 1/2] docs: Fix botched rST conversion of 'submitting-a-patch.rst'
Date: Mon, 22 Nov 2021 14:38:42 +0100
User-agent: Mozilla/5.0 (X11; Linux x86_64; rv:91.0) Gecko/20100101 Thunderbird/91.3.0

On 22/11/2021 14.33, Daniel P. Berrangé wrote:
On Mon, Nov 22, 2021 at 02:30:10PM +0100, Thomas Huth wrote:
On 22/11/2021 14.25, Peter Maydell wrote:
On Mon, 22 Nov 2021 at 12:37, Thomas Huth <thuth@redhat.com> wrote:
What about simply replacing it with a new sentence below the bullet list,

"Please also use a spell checker like `codespell
https://github.com/codespell-project/codespell` with your patches"

How many regular contributors actually do that?

Considering the typos that we have in the code, not enough ;-)

Anyway, it's just a polite recommendation here, not a must-do, so mentioning
codespell here doesn't really hurt, does it?

Well if you run 'codespell' with no args on qemu.git right now, you
get over 5000 possible mistakes reported. Many (perhaps even most)
will be false positives, but with that amount of existing report,
I don't think its credible to request contributors to run this
and wade through its results to see if they made things worse or

Ok, then maybe something like this:

"If your patch adds new documentation, then please also consider to use a spell checker like `codespell` to avoid typos in the new text" ?

Otherwise, I can also simply drop that sentence about spell checking.


reply via email to

[Prev in Thread] Current Thread [Next in Thread]