Hi Werner,
With regards to Andrea's points on the user list.
ScreenShots
I will continue doing more screen shots and send them in the original size.
Andrea, naming the images by the class name is fine, right? If there are
multiple ones for the same class I add just a number.
This is perfectly fine for me, although if you could name in the
following way it would be better:
- If it is a class belonging to the main wx namespace, just use the
class name in lower case (i.e., wx.Frame ==> frame.png)
- If it belongs to a sub-namespace (i.e., wx.dataview, wx.aui, wx.html
and so on), it should be named this way (examples):
1) wx.dataview.DataViewCtrl ==> dataview.dataviewctrl.png
2) wx.aui.AuiManager ==> aui.auimanager.png
and so on. What you are doing is of extremely great help.
Would be great if someone could do screen shots on *nix and/or Mac.
Yes, this is still on the todo-list for someone to step in...
Documentation changes
Would like to help here, but it looks that this is all "extractors.py" work
and this very much looks like it is over my head. However I can be
convinced otherwise:).
I believe it is much less complicated than you think. All the
docstrings for pure-Python classes/methods/functions are exposed in
the Python files themselves, for example on line 250 here:
http://svn.wxwidgets.org/viewvc/wx/wxPython/Phoenix/trunk/etg/_core.py?revision=70092&view=markup
It would be enough to edit the "doc" parameter for the "addPyClass"
and "PyFunctionDef" calls to make it more ReST-compliant, i.e. adding
the proper :ref:, :class:, :meth: roles, adding the :param: roles and
definition where it is missing and harmonize the Sphinx admonitions
(i.e., :see: ==> .. seealso::, :note: ==> .. note:: and so on).
Otherwise, I would say the bulk of wx.lib/wx.tools is in great need of
documentation-refactoring if you prefer to work on classic Python
docstrings. Any help in any direction is appreciated, so I guess you
may just choose what you like more
I'll upload my sources this evening with some more explanations.
Andrea.
"Imagination Is The Only Weapon In The War Against Reality."
http://xoomer.alice.it/infinity77/
···
On 30 December 2011 12:21, werner wrote: