[openstack-dev] Tool for detecting commonly misspelled words
dkranz at redhat.com
Tue Dec 3 19:47:32 UTC 2013
On 12/03/2013 02:05 PM, John Griffith wrote:
> On Tue, Dec 3, 2013 at 11:54 AM, Nachi Ueno <nachi at ntti3.com> wrote:
>> 2013/12/3 John Griffith <john.griffith at solidfire.com>:
>>> On Tue, Dec 3, 2013 at 11:38 AM, Russell Bryant <rbryant at redhat.com> wrote:
>>>> On 12/03/2013 09:22 AM, Joe Gordon wrote:
>>>>> HI all,
>>>>> Recently I have seen a few patches fixing a few typos. I would like to
>>>>> point out a really nifty tool to detect commonly misspelled words. So
>>>>> next time you want to fix a typo, instead of just fixing a single one
>>>>> you can go ahead and fix a whole bunch.
>>>>> To install it:
>>>>> $ pip install misspellings
>>>>> To use it in your favorite openstack repo:
>>>>> $ git ls-files | grep -v locale | misspellings -f -
>>>>> Sample output:
>>>> Are we going to start gating on spellcheck of code and commit messages? :-)
>>> NO please (please please please). We have enough "grammar reviewers"
>>> at this point already IMO and I honestly think I might puke if jenkins
>>> fails my patch because I didn't put a '.' at the end of my comment
>>> line in the code. I'd much rather see us focus on things like... I
>>> dunno... maybe having the code actually work?
>> yeah, but may be non-voting reviews by this tool is helpful
> Fair enough... don't get me wrong I'm all for support of non-english
> contributors etc. I just think that the emphasis on grammar and
> punctuation in reviews has gotten a bit out of hand as of late. FWIW
> I've never -1'd a patch (and never would) because somebody used "its"
> rather than "it's" in a comment. Or they didn't end a comment (NOT a
> docstring) with a period. I think it's the wrong place to spend
> effort quite honestly.
> That being said, I realize people will continue to this sort of thing
> (it's very important to get your -1 counts in the review stats) and
> admittedly there is some value to spelling and grammar. I just feel
> that there are *real* issues and bugs that people could spend this
> time that would actually have some significant and real benefit.
> I'm obviously in the minority on this topic so I should probably just
> yield at this point and get on board the grammar train.
I agree with you. But the last thread about this proved there is no
consensus. The beauty of a tool like this, run by individuals before
they submit, is that it will to some degree make this contentious issue
moot. I always run a spell checker on my own documents and I'm sure it
will give more confidence to non-native English speakers to run this on
their patches. So next time I see a misspelling in a review, I will
simply point the author at this tool to use in the future.
More information about the OpenStack-dev