Call Signature:
method(self, value)
or (my (admittedly C++ tinged) preference)
method( <strong>self</strong>, wxWindow <strong>value</strong> )
i.e. the method table can be used as a quick-reference which allows those
who are familiar with the control to rapidly determine argument order.
Eric:
My suggestion would be to include a self argument in the signature.
Python programmers are accustomed to seeing self and thinking "this is a
method of an object".
methodName (self, target, position)
Enjoy,
Mike
···
-----Original Message-----
From: David Priest [mailto:priest@sfu.ca]
Sent: Wednesday, April 19, 2000 11:54 AM
To: wxpython-users@wxwindows.org
Subject: RE: [wxPython] wxDocs
At 11:27 AM 00-04-19 -0400, you wrote:
1) Method table should have call signatures and a link to the full
description
Yes, I got lazy and didn't put the links in place for the demo. Please
give an example of what you mean by "call signature"...
2) Leave off the eric. etceteras (the table says methods, we know Python's
calling conventions)
Huh. And here I thought it was a lot less annoying that Robin's suggestion
of prepending "spam" to them all... <g> I find the "erics" annoying, too,
but do feel that there needs to be something. Perhaps a simple "x" will
suffice.
3) Event handler descriptions need to say what event is going to be passed,
preferably with a link to the relevant event class
Oops. Major oversight. Thanks for catching that one!
4) Argument types should have the expected types (and all the expected
types), for instance,
parent Reference to wxWindow or NULLor (my preference)
parent wxWindow or NULL
Ah! Yes, much better.
5) Don't know about having 3 screenshots/control, suppose they're useful
sometimes, but I'd rather have that on the web-site, not something I have
to
download in the primary documentation. How about just a single screenshot
at the top of the page, i.e. wxButton <image of button> to give an idea of
what the control looks like?
There may be ways to design the SGML/XML to eliminate some things when
rendering to paper, versus HTML.
Thanks for you feedback - very valued by me.
david
_______________________________________________
wxPython-users mailing list wxPython-users@wxwindows.org
http://wxwindows.org/mailman/listinfo/wxpython-users