From mboxrd@z Thu Jan 1 00:00:00 1970 Received: from pigeon.gentoo.org ([208.92.234.80] helo=lists.gentoo.org) by finch.gentoo.org with esmtp (Exim 4.60) (envelope-from ) id 1QGIih-0003fz-T9 for garchives@archives.gentoo.org; Sat, 30 Apr 2011 22:33:03 +0000 Received: from pigeon.gentoo.org (localhost [127.0.0.1]) by pigeon.gentoo.org (Postfix) with SMTP id 20F371C032; Sat, 30 Apr 2011 22:32:50 +0000 (UTC) Received: from mail-pz0-f53.google.com (mail-pz0-f53.google.com [209.85.210.53]) by pigeon.gentoo.org (Postfix) with ESMTP id 80D391C01F for ; Sat, 30 Apr 2011 22:32:13 +0000 (UTC) Received: by pzk6 with SMTP id 6so3992884pzk.40 for ; Sat, 30 Apr 2011 15:32:12 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=gamma; h=domainkey-signature:date:from:to:cc:subject:message-id:references :mime-version:content-type:content-disposition:in-reply-to :user-agent; bh=b8+g+8GRc27ZMXdjpGKfNcyibvxCrZTy3In2VPShv/Q=; b=RZQHyAMCDgmXIpBe4W4PsamHodQ4U4gBwVNA4eVLlfbFmSzrZ+1P2bsQpkzSEU6Aan dUngflevicKLde//LZy2rcb9k4/xpEpEUiv3NN0tzNtTlarzJCLLxitW7+uLoRJ0vM3X jxSdUt7vnt82e4BoRrddX+9S9dBeDmCv1TWTk= DomainKey-Signature: a=rsa-sha1; c=nofws; d=gmail.com; s=gamma; h=date:from:to:cc:subject:message-id:references:mime-version :content-type:content-disposition:in-reply-to:user-agent; b=WGByiDhEFEr/rxs6+Mo+jrMZcIvuTur8BBd0oBS0gSZ4stM2NWq8Na8JW23jWS9kVr oNs0OglJgOD9YnmQF8Yb6QqugDS9BSqgMCYjwRD7Lp29LMSoBaXAEJzb/IrtaUlzy0rx uFae1eZsN541VNnXr4tV0AKSOlRSYWqcYWKmU= Received: by 10.68.9.196 with SMTP id c4mr6960444pbb.461.1304202732812; Sat, 30 Apr 2011 15:32:12 -0700 (PDT) Received: from smtp.gmail.com (c-24-20-36-83.hsd1.wa.comcast.net [24.20.36.83]) by mx.google.com with ESMTPS id v8sm2795739pbk.95.2011.04.30.15.32.09 (version=TLSv1/SSLv3 cipher=OTHER); Sat, 30 Apr 2011 15:32:11 -0700 (PDT) Received: by smtp.gmail.com (sSMTP sendmail emulation); Sat, 30 Apr 2011 15:32:13 -0700 Date: Sat, 30 Apr 2011 15:32:13 -0700 From: Brian Harring To: gentoo-dev@lists.gentoo.org Cc: qa@gentoo.org Subject: Re: [gentoo-dev] python-namespaces.eclass Message-ID: <20110430223213.GD23166@hrair> References: <201104031938.18311.Arfrever@gentoo.org> <20110404114843.GA13291@hrair> <201104302327.51149.Arfrever@gentoo.org> Precedence: bulk List-Post: List-Help: List-Unsubscribe: List-Subscribe: List-Id: Gentoo Linux mail X-BeenThere: gentoo-dev@lists.gentoo.org Reply-to: gentoo-dev@lists.gentoo.org MIME-Version: 1.0 Content-Type: multipart/signed; micalg=pgp-sha1; protocol="application/pgp-signature"; boundary="mSxgbZZZvrAyzONB" Content-Disposition: inline In-Reply-To: <201104302327.51149.Arfrever@gentoo.org> User-Agent: Mutt/1.5.21 (2010-09-15) X-Archives-Salt: X-Archives-Hash: 0380cf860e607d553e08229d2b3b1d49 --mSxgbZZZvrAyzONB Content-Type: text/plain; charset=utf-8 Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sat, Apr 30, 2011 at 11:27:47PM +0200, Arfrever Frehtes Taifersar Arahes= is wrote: > 2011-04-04 13:48:43 Brian Harring napisa=C5=82(a): > > > # @ECLASS: python-namespaces.eclass > > > # @MAINTAINER: > > > # Gentoo Python Project > > > # @BLURB: Eclass for packages installing Python namespaces > > > # @DESCRIPTION: > > > # The python-namespaces eclass defines phase functions for packages i= nstalling Python namespaces. > >=20 > > ^^^ This isn't a useful description. >=20 > IMHO it's sufficient, but could you suggest some sentences of description? It probably is sufficient for *you*- you're knee deep in the guts of=20 python, and know it's purpose. Plus you wrote the eclass ;) The purpose of the description, and general code comments is for=20 *other* folk who may be looking at that code/problem for the first=20 time. It needs to be written aimed at them. I'd suggest doing a grep of DESCRIPTION w/in eclasses and working from=20 the clearer examples- just looking at the first few examples returned,=20 alternatives for example has enough in the opening description to=20 understand exactly what it's for, same for apache-2. One thing to keep in mind is that even for folk who know python, this=20 is actually an area that doesn't match the normal verbage, and is a=20 bit niche in it's usage- try googling 'python namespaces' sometime,=20 note that it's scope discussions rather than pkgutil/distribute=20 importation across multiple directories.=20 To be clear, 'python namespaces' is a whole other thing from what this=20 is doing- this is manipulation of importation pathways (the=20 module/import hierarchy/namespace, rather than the common scope=20 terminology). Either way, rough suggestion: """ This eclass handles installation/creation of python 2.7 and higher=20 pkgutil namespaces, and the equivalent distibute functionality. See=20 zope's (example ebuild) for examples of usage. """ Rewording it might be wise, but that lays out exactly what this is=20 for, it's intended usage, and gives folks a pointer were to look for=20 usage examples. ~brian --mSxgbZZZvrAyzONB Content-Type: application/pgp-signature -----BEGIN PGP SIGNATURE----- Version: GnuPG v2.0.15 (GNU/Linux) iEYEARECAAYFAk28je0ACgkQsiLx3HvNzgepYQCfc1TQDE1nxW4fWnry/t65vByf VtIAoN2tVto0xpm0/aqagve9pcpjKYNT =w658 -----END PGP SIGNATURE----- --mSxgbZZZvrAyzONB--