Re: [Distutils] setup.py clean questions
"TH" == Thomas Heller <thomas.heller@ion-tof.com> writes:
A meta-question, of course, is what the current status of documentation is. I can't find any mention of the clean command in the documentation on python.org. Is anyone currently working on these?
TH> Not currently. The situation is desperate. We're all waiting TH> for Greg.
TH> There are a lot of other commands not documented at all, only TH> the online help 'setup.py install_data --help'. TH> Even worse: Several options to the setup function are not TH> mentioned anywhere. TH> Although I'm not the right person to write docs (not beeing a TH> native english speaker), and I don't have any qualities as TH> author, I don't have any Latex experience, I'm in the process of TH> convincing me to at least write _some_ docs for some of these. Is there anything I can do to help convince you? I do not follow this list closely and only understand how to do very simple things with distutils. I've been waiting for documentation to learn the rest. I'm sure there are lots of people who can help with markup and copy editing, but fewer who can describe what the code actually does. Jeremy
Jeremy:
"TH" == Thomas Heller <thomas.heller@ion-tof.com> writes:
A meta-question, of course, is what the current status of documentation is. I can't find any mention of the clean command in the documentation on python.org. Is anyone currently working on these?
TH> Not currently. The situation is desperate. We're all waiting TH> for Greg.
TH> There are a lot of other commands not documented at all, only TH> the online help 'setup.py install_data --help'.
TH> Even worse: Several options to the setup function are not TH> mentioned anywhere.
TH> Although I'm not the right person to write docs (not beeing a TH> native english speaker), and I don't have any qualities as TH> author, I don't have any Latex experience, I'm in the process of TH> convincing me to at least write _some_ docs for some of these.
Is there anything I can do to help convince you? I do not follow this list closely and only understand how to do very simple things with distutils. I've been waiting for documentation to learn the rest.
I'm sure there are lots of people who can help with markup and copy editing, but fewer who can describe what the code actually does.
Jeremy Maybe we can join forces here on distutils and post documentation, other distutil developers can comment and improve it?
Thomas
I think it is far more important at this stage to document what exists than to work on any new features. We have far more working than most of us know how to use, which is a waste.
Ok, I will try to fill in some missing pieces. Thomas
I'd have to second this. I have a really tough time figuring out what setyp.py can and can't do due to the lack of docs. Digging into the source or other projects setup.py files to rediscover what others already know is very time consuming. Thanks for all the hard effort, James On Fri, 16 Feb 2001, Paul F. Dubois wrote:
I think it is far more important at this stage to document what exists than to work on any new features. We have far more working than most of us know how to use, which is a waste.
_______________________________________________ Distutils-SIG maillist - Distutils-SIG@python.org http://mail.python.org/mailman/listinfo/distutils-sig
->->->->->->->->->->->->->->->->->->---<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-< James Thompson 138 Cardwell Hall Manhattan, Ks 66506 785-532-0561 Kansas State University Department of Mathematics ->->->->->->->->->->->->->->->->->->---<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<-<
James Thompson wrote:
I'd have to second this. I have a really tough time figuring out what setyp.py can and can't do due to the lack of docs. Digging into the source or other projects setup.py files to rediscover what others already know is very time consuming.
The code is very well documented, though. What's missing sometimes is an overview of how data (esp. attributes) and objects move around while executing setup.py and how the control flow really works. -- Marc-Andre Lemburg ______________________________________________________________________ Company: http://www.egenix.com/ Consulting: http://www.lemburg.com/ Python Pages: http://www.lemburg.com/python/
On Fri, Feb 16, 2001 at 08:15:01AM -0800, Paul F. Dubois wrote:
I think it is far more important at this stage to document what exists than to work on any new features. We have far more working than most of us know how to use, which is a waste.
Indeed. I'm inclined to keep saying "no" to feature requests in the 2.1 time frame, and just fix any reported bugs and work on improving the docs. Uninstallers and the like will have to be left to 2.2, possibly requiring a PEP. Feel free to continue discussing this, though; just be aware that there's no great hurry since the work won't be for 2.1. --amk
participants (6)
-
Andrew Kuchling -
James Thompson -
Jeremy Hylton -
M.-A. Lemburg -
Paul F. Dubois -
Thomas Heller