wxPython Demo Maintenance
This wiki page is a place to coordinate efforts to maintain and update the wxPython demo, especially during the transition from V2.4 to V2.5. This point is especially critical because wxPython is moving completely to the new wx namespace.
Front matter
One person is coordinating this effort, though all are welcome to contribute.
Coordinator: [mailto:grimmtooth@softhome.net Jeff Grimmett]
- Current status: Just starting
Contributing
If you wish to contribute to this effort, we ask that you work within this framework if possible:
Please contact the [mailto:grimmtooth@softhime.net demo maintenance coordinator] if you have any questions.
Please work with a copy from [http://www.wxpython.org/download.php#cvsaccess CVS] if possible. If that is not possible, please use the latest 2.4 release as a starting point.
- Please follow the coding guidelines indicated below.
- If you hve write access to CVS, please notify the coordinator of any changes that you make (just in case)
Likewise, if you submit a patch directly through the [http://sourceforge.net/tracker/?group_id=10718&atid=310718 patching engine], please notify the coordinator just to be safe.
- Updates directly to the coordinator as patches or whole files are always welcome.
- Please test the demo code both as a standalone as well as from within the main demo itself.
Coding Guidelines
Robin has requested a number of things as we progress through the demo, and there are some things I'd like to see as well. Most are optional, but the more that gets done, the better the demo will be.
Please observe the [http://www.wxpython.org/codeguidelines.php wxPython Coding Guidelines]
- Naturally, all wxPython library calls must be expunged and replaced with calls using the new namespace.
- (nice to have) Where feasable, replace instances of wxPoint() and wxSize() with two-tuples.
- (nice to have) Early on, wxPython didn't support keyword args. In cases where keyword args are now supported but not being used, they should be. This will present a consistent presentation throughout the demo.
wxNamedColour isn't needed anymore, just pass strings where the colour is needed and they will automatically be converted to wxColour.
- (nice to have) Comments: review the demo code you are updating: are the comments sufficient? Remember, this is a learning tool. If the comments are inadequate and you understand the code, please take the time to update it.
- (nice to have) Overview strings: please review the overview strings for accuracy. If they are out of date or missing, please add it if possible.
- At the top of the code, please indicate when the code was modified, by who, and the nature of the modifications (laborious detail is not necessary, that's what diff tools are for).
- Also at the top of the code, please indicate how the code was tested - platform, version of demo, that sort of thing.
Contributors
Contributors of libraries or other custom work to the body of work of wxPython are requested to update thier demos themselves. This is not a requirement -- what we don't get contributed by the authors will be modified by the demo team, but this does provide the best assurance that the code is modified appropriately.
If you have a class or library contributed and don't intend to upate the demo, please update the coordinator regarding this and we'll take care of the rest.
Platforms
- The coordinator only has access to W2K and Debian Linux. Mac or other platforms should be tested by those that have them.
Todo
- Establish some sort of way to list what is being worked on by who, or what is completed, or whatever. Work in progress.
How about this: ["wxPython 2.5 Demo Update Status"]