Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 24 Jul 2012 19:34:00 -0700
From:      Doug Barton <dougb@FreeBSD.org>
To:        Alexey Dokuchaev <danfe@FreeBSD.org>
Cc:        svn-ports-head@freebsd.org, svn-ports-all@freebsd.org, Carlo Strub <cs@FreeBSD.org>, ports-committers@freebsd.org
Subject:   Re: svn commit: r301497 - in head: databases/rubygem-dm-migrations deskutils/libgcal deskutils/p5-ZConf-BGSet deskutils/p5-ZConf-Runner deskutils/xrolo devel/alabastra devel/librcd devel/py-pytemplate ...
Message-ID:  <500F5B18.1010105@FreeBSD.org>
In-Reply-To: <20120725022501.GA98315@FreeBSD.org>
References:  <201207242127.q6OLRE9x075919@svn.freebsd.org> <20120725022501.GA98315@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
On 07/24/2012 19:25, Alexey Dokuchaev wrote:
> On Tue, Jul 24, 2012 at 09:27:14PM +0000, Carlo Strub wrote:
>> Author: cs
>> Date: Tue Jul 24 21:27:13 2012
>> New Revision: 301497
>> URL: http://svn.freebsd.org/changeset/ports/301497
>>
>> Log:
>>   Fix typos in COMMENT
> 
> Thanks for doing this, much appreciated! 

++

> I've noticed some potential bugs however, see below...

I've been resisting the urge to quibble on this stuff since I really
appreciate Carlo's work here, but since you brought it up ... :)

>> +++ head/deskutils/p5-ZConf-Runner/Makefile
>> @@ -13,7 +13,7 @@ MASTER_SITE_SUBDIR=	CPAN:VVELOX
>>  PKGNAMEPREFIX=	p5-
>>  
>>  MAINTAINER=	vvelox@vvelox.net
>> -COMMENT=	Run a file using a choosen methode, desktop entry or mimetype
>> +COMMENT=	Run a file using a chosen method, desktop entry or mimetype
> 
> This could benefit from comma before "or" I think.

Search for "Oxford comma" for more info on this. Short version, it's
allowed at minimum, many would also say preferred, but it is not mandatory.

>> +++ head/devel/py-pytemplate/Makefile
>> @@ -12,7 +12,7 @@ MASTER_SITES=	http://www.bulot.org/downl
>>  PKGNAMEPREFIX=	${PYTHON_PKGNAMEPREFIX}
>>  
>>  MAINTAINER=	benoit@litchis.org
>> -COMMENT=	Pytemplate gives python developpers a starting framework
>> +COMMENT=	Pytemplate gives python developers a starting framework
> 
> Using port's name in COMMENT should generally be avoided.

Right, should start with "Gives ..."

Also, the names of languages like "Perl" and "Python" are generally
capitalized in formal contexts.

>> +++ head/net-im/emesene/Makefile
>> @@ -14,7 +14,7 @@ MASTER_SITES=	${MASTER_SITE_LOCAL:S,$,ac
>>  		${MASTER_SITE_GOOGLE_CODE}
>>  
>>  MAINTAINER=	acm@FreeBSD.org
>> -COMMENT=	A MSN Messenger client writen in python
>> +COMMENT=	A MSN Messenger client written in python
> 
> Shouldn't it be "An MSN ... in Python" ?

Our comment format is to not start with a leading article at all. So
just "MSN Messenger ..."

hth,

Doug

-- 

    Change is hard.






Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?500F5B18.1010105>