| 1 |
On Sat, Apr 30, 2011 at 11:27:47PM +0200, Arfrever Frehtes Taifersar Arahesis wrote: |
| 2 |
> 2011-04-04 13:48:43 Brian Harring napisał(a): |
| 3 |
> > > # @ECLASS: python-namespaces.eclass |
| 4 |
> > > # @MAINTAINER: |
| 5 |
> > > # Gentoo Python Project <python@g.o> |
| 6 |
> > > # @BLURB: Eclass for packages installing Python namespaces |
| 7 |
> > > # @DESCRIPTION: |
| 8 |
> > > # The python-namespaces eclass defines phase functions for packages installing Python namespaces. |
| 9 |
> > |
| 10 |
> > ^^^ This isn't a useful description. |
| 11 |
> |
| 12 |
> IMHO it's sufficient, but could you suggest some sentences of description? |
| 13 |
|
| 14 |
It probably is sufficient for *you*- you're knee deep in the guts of |
| 15 |
python, and know it's purpose. Plus you wrote the eclass ;) |
| 16 |
|
| 17 |
The purpose of the description, and general code comments is for |
| 18 |
*other* folk who may be looking at that code/problem for the first |
| 19 |
time. It needs to be written aimed at them. |
| 20 |
|
| 21 |
I'd suggest doing a grep of DESCRIPTION w/in eclasses and working from |
| 22 |
the clearer examples- just looking at the first few examples returned, |
| 23 |
alternatives for example has enough in the opening description to |
| 24 |
understand exactly what it's for, same for apache-2. |
| 25 |
|
| 26 |
One thing to keep in mind is that even for folk who know python, this |
| 27 |
is actually an area that doesn't match the normal verbage, and is a |
| 28 |
bit niche in it's usage- try googling 'python namespaces' sometime, |
| 29 |
note that it's scope discussions rather than pkgutil/distribute |
| 30 |
importation across multiple directories. |
| 31 |
|
| 32 |
To be clear, 'python namespaces' is a whole other thing from what this |
| 33 |
is doing- this is manipulation of importation pathways (the |
| 34 |
module/import hierarchy/namespace, rather than the common scope |
| 35 |
terminology). |
| 36 |
|
| 37 |
Either way, rough suggestion: |
| 38 |
""" |
| 39 |
This eclass handles installation/creation of python 2.7 and higher |
| 40 |
pkgutil namespaces, and the equivalent distibute functionality. See |
| 41 |
zope's (example ebuild) for examples of usage. |
| 42 |
""" |
| 43 |
|
| 44 |
Rewording it might be wise, but that lays out exactly what this is |
| 45 |
for, it's intended usage, and gives folks a pointer were to look for |
| 46 |
usage examples. |
| 47 |
~brian |
Archives