[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [Qemu-devel] Wanted: reviewers for english style and grammar
From: |
Eduardo Habkost |
Subject: |
Re: [Qemu-devel] Wanted: reviewers for english style and grammar |
Date: |
Thu, 20 Sep 2018 16:24:46 -0300 |
User-agent: |
Mutt/1.9.2 (2017-12-15) |
On Thu, Sep 20, 2018 at 01:57:34PM -0500, Eric Blake wrote:
> On 9/20/18 1:45 PM, Eduardo Habkost wrote:
> > When reviewing some patches that touch documentation or error
> > messages, I often think we could improve readability, but I don't
> > trust my english skills completely when suggesting improvements.
> >
> > I wonder if we could find a group of people that would volunteer
> > to be listed on MAINTAINERS as willing to review english style
> > and grammar on documentation and UI messages?
>
> I certainly fill that role on patches I notice (I've got my emails set up to
> automatically flag patches that touch docs/ and qapi/, which tend to be a
> common point of user-visible documentation - but it doesn't catch things
> like error messages embedded in code). My technical concern, however, is
> how you would specify such an entry in MAINTAINERS. If it's merely a
> comment, it won't help anyone relying on ./scripts/get_maintainer.pl
> automation. If it's a regex trying to identify patches that add error
> messages, I worry that it will fire so frequently that it will overload the
> inbox of anyone listed in that role with cc's. And even if we find a
> suitable listing, probably with a regex, there's still no obvious way to
> distinguish mails looking for just grammar review vs. mails that are more
> pertinent to my pull requests and want a technical review. I guess I could
> always list a mailbox alias under one heading and not the other, and sort
> mails by which alias the mail came through to determine the intent for why I
> was cc'd, although that's sounding a bit more complex (and also, would it
> play well with mailman's weirdness in rewriting cc rules when a receiver has
> expressed an interest in no duplicate emails?).
Yeah, this seems very hard to automate. What I'm looking for is
just a list of people that wouldn't mind if CC them when looking
for feedback on English grammar or style.
--
Eduardo