what should we be looking at on the documentation front?

Robin are you going to be emphasizing the auto-generated documentation, doc strings, etc. for 2.5.2.x?

ka

Kevin Altis wrote:

Robin are you going to be emphasizing the auto-generated documentation, doc strings, etc. for 2.5.2.x?

The new stuff still isn't complete enough to switch over (I havn't done much with it for the last month or so,) however everything does have a docstring that at least documents the parameter names and default values. So there is some usefulness there.

I plan on making both sets of docs available for at least this release, I just need to integrate the building of the new docs into the new automated build tools.

···

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

How about Getting Started doc? A lot of people are using "the old way" aka from wxPython.wx import * and co. because this is the first thing they learn. This is obvious from the wxpython-users mailing list. Shouldn't there be a "spring clean-up" of that tutorial? Maybe ported to 2.5.2.2 :wink: also the PDF, html, and ASCII versions should actually exist and at least one of them be part of the wxpython distribution.
Also I think that a Getting started guide should take in consideration that not everybody installs stuff on their PC... installation should be moved to a separate, dedicated page.
SciTE, BoaConstructor, PyCrust belong to a Tools page mentioned in the Getting Started page.

I know Robin does not have time for something like this but maybe someone else could take up the challenge.
As you have already noticed Tom Blackwell ported the examples to wx namespace BUT most new users never get there.

One last thing... I think that the Getting Started tutorial should be written for a user with very short attention span... like for a kid (or like me :wink: ), so it should be simplified to the maximum, used something like YAGNI, only the basics.

···

On Tue, 20 Jul 2004 14:25:09 -0700, Robin Dunn <robin@alldunn.com> wrote:

The new stuff still isn't complete enough to switch over (I havn't done much with it for the last month or so,) however everything does have a docstring that at least documents the parameter names and default values. So there is some usefulness there.

I plan on making both sets of docs available for at least this release, I just need to integrate the building of the new docs into the new automated build tools.

--
Peter Damoc
Hacker Wannabe
http://www.sigmacore.net/

Peter Damoc wrote:

The new stuff still isn't complete enough to switch over (I havn't done much with it for the last month or so,) however everything does have a docstring that at least documents the parameter names and default values. So there is some usefulness there.

I plan on making both sets of docs available for at least this release, I just need to integrate the building of the new docs into the new automated build tools.

How about Getting Started doc? A lot of people are using "the old way" aka from wxPython.wx import * and co. because this is the first thing they learn. This is obvious from the wxpython-users mailing list. Shouldn't there be a "spring clean-up" of that tutorial? Maybe ported to 2.5.2.2 :wink: also the PDF, html, and ASCII versions should actually exist and at least one of them be part of the wxpython distribution.
Also I think that a Getting started guide should take in consideration that not everybody installs stuff on their PC... installation should be moved to a separate, dedicated page.
SciTE, BoaConstructor, PyCrust belong to a Tools page mentioned in the Getting Started page.

I know Robin does not have time for something like this but maybe someone else could take up the challenge.

Since it is a wiki that anybody can edit, *you* could volunteer. :wink:

As you have already noticed Tom Blackwell ported the examples to wx namespace BUT most new users never get there.

One last thing... I think that the Getting Started tutorial should be written for a user with very short attention span... like for a kid (or like me :wink: ), so it should be simplified to the maximum, used something like YAGNI, only the basics.

What's YAGNI?

···

On Tue, 20 Jul 2004 14:25:09 -0700, Robin Dunn <robin@alldunn.com> wrote:

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

Since it is a wiki that anybody can edit, *you* could volunteer. :wink:

I was afraid you would say that :wink: I'll see what I can do, can't promise anything due to chronic procrastination :slight_smile:

What's YAGNI?

YAGNI = 'You Aren't Going to Need It', along with 'Do the Simplest Thing That Could Possibly Work' represent the atitude of XP towards development. :slight_smile:

···

On Thu, 22 Jul 2004 10:53:34 -0700, Robin Dunn <robin@alldunn.com> wrote:

--
Peter Damoc
Hacker Wannabe
http://www.sigmacore.net/