[wxruby-users] Documentation changes?

[David Peoples]

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?

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:

---------------------------------------------------------------------
As of version 1.9.1, it is possible to use named keyword arguments to
specify constructor parameters in arbitrary order. The names of the
arguments can be got from the class documentation. Omitted arguments
will be given their default value. The above call could look like

text = Wx::TextCtrl.new(parent, :text => 'some text', 
                                :style => Wx::TE_MULTILINE)

For a full description of the new calling style, see the 
[wxRuby Overview]
---------------------------------------------------------------------

Any comments?

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


David Peoples