From owner-svn-ports-all@freebsd.org Tue Nov 28 16:40:07 2017 Return-Path: Delivered-To: svn-ports-all@mailman.ysv.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) by mailman.ysv.freebsd.org (Postfix) with ESMTP id 81ACDDE3706; Tue, 28 Nov 2017 16:40:07 +0000 (UTC) (envelope-from danfe@freebsd.org) Received: from freefall.freebsd.org (freefall.freebsd.org [96.47.72.132]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client CN "freefall.freebsd.org", Issuer "Let's Encrypt Authority X3" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 625F46D8E4; Tue, 28 Nov 2017 16:40:07 +0000 (UTC) (envelope-from danfe@freebsd.org) Received: by freefall.freebsd.org (Postfix, from userid 1033) id B3FB81C1; Tue, 28 Nov 2017 16:40:06 +0000 (UTC) Date: Tue, 28 Nov 2017 16:40:06 +0000 From: Alexey Dokuchaev To: Adam Weinberger Cc: Dan Langille , ports-committers@freebsd.org, svn-ports-all@freebsd.org, svn-ports-head@freebsd.org Subject: Re: svn commit: r455056 - head/devel/py-naiveBayesClassifier Message-ID: <20171128164006.GC43542@FreeBSD.org> References: <201711281612.vASGCWJI056613@repo.freebsd.org> <20171128161915.GB43542@FreeBSD.org> <028241A0-ED33-4BF2-BC3F-F723B00072EB@adamw.org> MIME-Version: 1.0 Content-Type: text/plain; charset=us-ascii Content-Disposition: inline In-Reply-To: <028241A0-ED33-4BF2-BC3F-F723B00072EB@adamw.org> User-Agent: Mutt/1.9.1 (2017-09-22) X-BeenThere: svn-ports-all@freebsd.org X-Mailman-Version: 2.1.25 Precedence: list List-Id: SVN commit messages for the ports tree List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Tue, 28 Nov 2017 16:40:07 -0000 On Tue, Nov 28, 2017 at 09:26:55AM -0700, Adam Weinberger wrote: > > On 28 Nov, 2017, at 9:19, Alexey Dokuchaev wrote: > > On Tue, Nov 28, 2017 at 04:12:32PM +0000, Dan Langille wrote: > >> [...] > >> +COMMENT= Yet another general purpose naive bayesian classifier > >> [...] > >> +++ head/devel/py-naiveBayesClassifier/pkg-descr > >> @@ -0,0 +1,4 @@ > >> +yet another general purpose Naive Bayesian classifier. > >> +(under heavy development) > > > > Inconsistent capitalization in COMMENT vs. pkg-descr; also, typically > > port description text should contain a little more information about > > the port (see section 3.2.1 of the PHB for some hints). > > This is something that we have really regressed on lately. Our pkg-descrs > are becoming very terse, often simply repeating the COMMENT. Someone, I > forget who, recently added a bunch of ports without even listing WWW. We > have many ports broken into sections or variants where they all share the > same descr, so now I have no idea which one I actually want to install. Big +1, I appreciate the support Adam. > Folks, the descr is our catalogue; it's the first place that end-users > learn about ports and decide which one they're looking for. Take the 2 > minutes to write a meaningful description, [...] Exactly. I can give an advice: if upstream lacks elaborate description, and you're having difficulty coming up with one of your own, take a look at some GNU/Linux distros that provide the same (or similar) package. I recall adding `sysutils/radeontop' and not being happy with pkg-descr (in r436717) until I found better description in Linux Mint package, cf. r436868. HTH, ./danfe