[Distutils] feeback on the distutils documentation

Michele Simionato michele.simionato at gmail.com
Thu Feb 3 15:28:23 CET 2005


Hi Greg,

I am reading the distutils documentation and I would like to give some
feedback. Generally speaking the documentation is pretty good but there
two or three minor issues.
First of all, the simple example described at 
http://www.python.org/doc/2.4/dist/simple-example.html is not that good:
if I try to run it as it is, I get a few error messages, since some required
metadata are missing. However to discover what are the required metadata,
I have to go at http://www.python.org/doc/2.4/dist/meta-data.html,
which, BTW, does not list all the metadata. To discover the full list
I had to look at the source code, at the DistributionMetadata class.

In particular, http://www.python.org/doc/2.4/dist/meta-data.html should
list the platforms metadata, which is not required, but if you don't
give it the PKG-INFO file will have an ugly "Platform: UNKNOWN" entry.

I haven't yet finished the reading yet, so I could have additional
feedback in a short while. BTW, I appreciate very much your work,
including optparse and quixote and your documentation style ;)

Keep the good work going,

                     Michele


P.S. the address in the example
http://www.python.org/doc/2.4/dist/setup-script.html
(gward at python.net) does NOT work!


More information about the Distutils-SIG mailing list