Misc complaints about wxPython documentation

I really appreciate the work done on wxWindows and wxPython to provide a cross platform UI API, but there are some things that really irk me about working with WxPython. While hunting down the problem in my previous blog post about the artifacts in the Cairo rendered image background, I found the problem was with the way in which I was blitting. Was I doing it wrong? I don’t know. The API docs sometimes omitted the methods I was trying to use, depending on which version I was looking at. I tried to find the documentation for the specific version I have, but was unable to find docs for that version because the wxpython site has the habit of hiding or removing docs every time they release a new version. On top of that problem, when I try to get help on a python module or method from within a python interpreter, I get an exception. Even when I am willing to assume the docs on the web site are the same for the version I have, I find the API docs lacking any kind of detail. The wxWindows API docs are detailed and usually helpful, but the wxPython API docs lack any detail. Compare these two API docs for the Bitmap class:

wxPython

wxWindows

If you are going to force me to read the wxPython docs to get the arguments right, and the wxWindows docs to understand what the arguments mean, at least provide me a link…

2 thoughts on “Misc complaints about wxPython documentation

  1. avatarDave Kirby

    While you are on the subject, take a look at the traits documentation.

    I am working with traits 2, and the UI user guide leaves a lot to be desired – scattered through text are references to things that will be explained in chapters 9 and 10, but these chapters are left as outlines. I took a look at the traits 3 user guide to see if the topics are covered there, but those chapters have been removed completely.

    It also often gives examples of using classes, but gives no indication which module to import them from. Several times I have had to grep through the library source to find the class definition.

    Similarly it often tells you what attributes a class has, but no indication of what values the attributes take or what they mean. For example the View width and height – from experimenting and looking at examples I deduce they are expressed as a decimal proportion of the screen size, but that is not explained in the guide.

    You also said “If you are going to force me to read the wxPython docs to get the arguments right, and the wxWindows docs to understand what the arguments mean, at least provide me a link”

    I agree – the Traits UI user guide could also do with links to the API docs – this is tricky in the Traits 2 manual since it is PDF, but from what I have seen of the online Traits 3 UIUG, it has no links to the API docs either.

    Reply
  2. avatarBryce

    Dave,

    Good point(s). I rarely look at the Traits docs, so its easy to forget how much work they still need. I’ll make sure to bring this up internally.

    Reply

Leave a Reply

Your email address will not be published. Required fields are marked *

Please leave these two fields as-is:

Protected by Invisible Defender. Showed 403 to 101,047 bad guys.