Date: Tue, 28 Jan 2014 21:14:46 +1100 From: Kubilay Kocak <koobs.freebsd@gmail.com> To: Ruslan Makhmatkhanov <cvs-src@yandex.ru>, Alexey Dokuchaev <danfe@FreeBSD.org> Cc: svn-ports-head@freebsd.org, svn-ports-all@freebsd.org, ports-committers@freebsd.org Subject: Re: svn commit: r341401 - head/www/py-requests1 Message-ID: <52E78316.7010708@FreeBSD.org> In-Reply-To: <52E7785A.1070804@yandex.ru> References: <201401271318.s0RDInCu014881@svn.freebsd.org> <20140127140508.GA68244@FreeBSD.org> <52E66ABB.5000002@FreeBSD.org> <20140127143457.GB71123@FreeBSD.org> <52E7785A.1070804@yandex.ru>
next in thread | previous in thread | raw e-mail | index | archive | help
On 28/01/2014 8:28 PM, Ruslan Makhmatkhanov wrote: > Alexey Dokuchaev wrote on 27.01.2014 18:34: >> On Tue, Jan 28, 2014 at 01:18:35AM +1100, Kubilay Kocak wrote: >>> By default, most Python maintainers use the short description found in >>> either the modules setup.py metadata, or the short tag/summary from the >>> projects site verbatim, unless there is good reason to do so. In this >>> case: http://docs.python-requests.org/en/latest/ [...] >>> >>> For what it's worth, "for human beings" is almost a convention in Python >>> land for modules with 'beautiful developer API\'s' >> >> Right, in Python land it is. However, as a generic packager (that is, >> FreeBSD Project) we should provide package descriptions (that includes >> both COMMENT and pkg-descr) that can be comprehended by anyone, not just >> someone necessarily coming from the Python land. >> >> In this particular case, more neutral COMMENT, like "convenient (or easy >> to use) HTTP module/functions bundle" would IMHO be better. >> >> This is just my nit picking of course; no need to take any immediate >> action(s). >> >> ./danfe > > It's doubtful that Joe Average occasionally getting this port as > dependency will ever care about what it does. While to "someone coming > from the Python land" the meaning of it would be quite obvious. > This might be true, but I will grant Alexey that the "Python people know what it means" is the weakest of my arguments. My second point still stands; that the comment meets all the criteria I can think of for a short yet descriptive summary of what a port is, and/or what it provides. "HTTP library written in Python for human beings (Version 1.x)" It is; version 1.x of, a library, for HTTP, written in Python, for humans. On second look however, I *should* also be including the commas where they exist upstream (commas matter!,) though I dont know if we like commas in COMMENTS :) ./koobs
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?52E78316.7010708>