[wxruby-users] Documentation changes?

[Chauk-Mean Proum]

Hi David,

On Wed, Mar 11, 2009 at 6:00 AM, David Peoples
<davidp at touringcyclist.com> wrote:
> I'm embarrassed but willing to admit that I completely missed for a
> couple weeks the "wxRuby Overview" page of the documentation that
> explains the more ruby-like calling method with named arguments. I
> realized something was up when working through the examples, and finally
> found the relevant page when I knew it must be there.
>
> For slow guys like me, I'd like to see the whole documentation updated
> to include the "keyword parameter" calling method for every function in
> every class. I know, a ton of work, where's my patch?

FYI, in addition to constructors for Window and its subclasses, there
are 2 other methods that support named arguments :
- ToolBar#add_item
- Sizer#add_item
They are described in the overview part and the detailed part of the
corresponding documentation page :
- http://wxruby.rubyforge.org/doc/toolbar.html#ToolBar_additem
- http://wxruby.rubyforge.org/doc/sizer.html#Sizer_additem

> I don't have that patch, but I do have a suggestion slightly more
> practical. I think every class description page could have a section
> near the top with a paragraph similar to this one taken from the
> "overview" page:

For the Window constructors, instead of duplicating the description in
each method of each class, a link to the wxRuby overview could be
sufficient.

> What is the procedure for submitting patches to the wxRuby documentation?

This is described at :
http://wxruby.rubyforge.org/wiki/wiki.pl?DocumentingWxRuby

Note that since the release of wxRuby-2.0, there has been some
reorganisation in the subversion repository.
You should check out for the stable 2.0 branch :
http://wxruby.rubyforge.org/svn/branches/wxruby_2_0_stable

Cheers.

Chauk-Mean.