svn commit: r301497 - in head: databases/rubygem-dm-migrations deskutils/libgcal deskutils/p5-ZConf- [...] [ID#2012072509000198]

[Carlo Strub]

07/25/2012 05:00 - Doug Barton wrote:

> On 07/24/2012 19:46, Alexey Dokuchaev wrote:
> > Now that you've mentioned it, yes, we have a large diversity in using
> > indefinite article in the beginning of COMMENT line.  I would also want us
> > to settle on some standard.  If you say it should be dropped, so let it be.
> 
> Oh how I wish I had such power. :)
> 
> The rule has always been "No article at the beginning of the COMMENT."
> Unfortunately not only is TPH insufficiently clear on this point, the
> actual (long-time historical) example given is misleading in the sense
> that it seems to not only allow, but to encourage an indefinite article.
> The specific usage in the case of the port referenced would be allowed
> because it's a whimsical description of what the port does, rather than
> a description of the port itself. However, it's still a painfully bad
> example.
> 
> I would gladly punch up this page of the handbook if there is consensus
> to do so.
> 
> Doug
> 
> -- 
> 
>     Change is hard.
> 
> 
> 
> 

Hi Doug, hi Alexey,
Thanks for the kind words and hints. When I started searching for typos, I thought there will be just a few. I am really shocked how many, sometimes stupid, errors there are just in COMMENT -- not to mention pkg-descr... Please, all committers, make sure you double check spelling in your submissions.

And yes, Doug, please do add your comments to TPH. Regarding your comments Alexey, I try to fix them and more grammatical errors (I was aware of them). But, so far I am happy if I can fix the simple typos in our many ports :-)

Maybe fixing the pkg-descr files could become a good Google Code-In project for young people.

Cheers,
Carlo



--
Carlo Strub
Ports committer
--