help with help(wxWindows.GetChildren) and similar

Hi

I'm using wxPython and would like to know what you guys do when you need help on a member function. For example typing

    help(wxWindows.GetChildren)

returns the following
       Help on method GetChildren in module wxPython.windows:

    GetChildren(self, *_args, **_kwargs) unbound wxPython.windows.wxWindow method

I don't find this very useful especially since their is no indication what the parmaters to the function should be. At the moment I'm using the wxWindows C++ documentation combined with a dose of trial and error and a side of wxPython demo to work out what the parameters to member functions are. However this is less than ideal so if anybody has any tips please advise.

Thanks

···

--
sashan
http://www.cs.auckland.ac.nz/~sgov008/

sashan wrote:

Hi

I'm using wxPython and would like to know what you guys do when you need help on a member function. For example typing

   help(wxWindows.GetChildren)

returns the following
     Help on method GetChildren in module wxPython.windows:

   GetChildren(self, *_args, **_kwargs) unbound wxPython.windows.wxWindow method

I don't find this very useful especially since their is no indication what the parmaters to the function should be. At the moment I'm using the wxWindows C++ documentation combined with a dose of trial and error and a side of wxPython demo to work out what the parameters to member functions are. However this is less than ideal so if anybody has any tips please advise.

In 2.5 all functions and methods will have docstrings that contain at least the function signature (parameter names, types and return type) and summary descriptions are being added to the docstrings as I have time. There is also the ability to add more detailed docs for each item and there is an XML metadata file being generated with the various doc snippets and parameter info that can be used to generate more advanced docs.

···

--
Robin Dunn
Software Craftsman
http://wxPython.org Java give you jitters? Relax with wxPython!