# API doc update coming?

**URL:** <https://www.ruby-forum.com/t/api-doc-update-coming/118122>\
**Category:** wxRuby\
**Created:** [October 24, 2007, 2:33am UTC](https://www.ruby-forum.com/t/api-doc-update-coming/118122 "2007-10-24T02:33:55Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![unknown](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/u/4bbf92/32.png) [@unknown](https://www.ruby-forum.com/u/unknown)\
**Post date:** [October 24, 2007, 2:33am UTC](https://www.ruby-forum.com/t/api-doc-update-coming/118122/1 "2007-10-24T02:33:55Z")

</div>

I’ve upgraded from 1.9.0 to 1.9.2 and am finding that  
the errors I’m getting don’t match the docs. For example,  
in Wx::ListCtrl:

- The doc makes no mention of on\_get\_item\_column\_image(),  
but without this method I get NoMethodError.

- The doc says on\_get\_item\_attr() _may_ be overloaded,  
but if I don’t define it, I get NoMethodError.

The API doc appears to be rife with inconsistencies like  
this. Is anyone working on updating it? Sorry to whine,  
but newbies like me need all the hand-holding we can get!

Also, the Wx::Sizer page has a broken link to “Sizer  
overview”. Oh how I need that overview – I don’t have  
any idea how layouts work in GUIs and trying to figure  
out how to use the Sizer classes is proving quite a  
challenge. (The sample programs are a big help, but an  
overview would give me a leg up on the learning curve.)

Thanks,  
Peralta

---

<div class="post-metadata">

**Author:** ![unknown](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/u/4bbf92/32.png) [@unknown](https://www.ruby-forum.com/u/unknown)\
**Post date:** [October 24, 2007, 9:05am UTC](https://www.ruby-forum.com/t/api-doc-update-coming/118122/2 "2007-10-24T09:05:58Z")

</div>

Hi Peralta,

2007/10/24, removed\_email\_address@domain.invalid [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid):

> Also, the Wx::Sizer page has a broken link to “Sizer  
> overview”. Oh how I need that overview – I don’t have  
> any idea how layouts work in GUIs and trying to figure  
> out how to use the Sizer classes is proving quite a  
> challenge.

Indeed, the link is broken. Meanwhile, there is a page on the wxRuby  
wiki that explains Sizer concepts.

[http://wxruby.rubyforge.org/wiki/wiki.pl?Using\_Sizers\_For\_Layout](http://wxruby.rubyforge.org/wiki/wiki.pl?Using_Sizers_For_Layout)

I can’t help you for the other questions related with ListCtrl.

Cheers.

Chauk-Mean.

---

<div class="post-metadata">

**Author:** ![unknown](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/u/4bbf92/32.png) [@unknown](https://www.ruby-forum.com/u/unknown)\
**Post date:** [October 24, 2007, 10:37am UTC](https://www.ruby-forum.com/t/api-doc-update-coming/118122/3 "2007-10-24T10:37:24Z")

</div>

Hi Peralta

removed\_email\_address@domain.invalid wrote:

> I’ve upgraded from 1.9.0 to 1.9.2 and am finding that  
> the errors I’m getting don’t match the docs. For example,  
> in Wx::ListCtrl:
> 
> - The doc makes no mention of on\_get\_item\_column\_image(),  
> but without this method I get NoMethodError.
> 
> - The doc says on\_get\_item\_attr() _may_ be overloaded,  
> but if I don’t define it, I get NoMethodError.

Thanks for the report; the docs are right and the library is wrong. I  
had meant to check in a patch for this a while back but forgot. It  
should be fixed now for 1.9.3. The changed file is here:  
[http://wxruby.rubyforge.org/svn/trunk/wxruby2/lib/wx/classes/listctrl.rb](http://wxruby.rubyforge.org/svn/trunk/wxruby2/lib/wx/classes/listctrl.rb)

> The API doc appears to be rife with inconsistencies like  
> this. Is anyone working on updating it?

No-one is working on it, in the same sense as no-one is working on  
wxRuby as a whole. There is a small team of volunteers who, in their  
spare time, make additions and corrections to the docs with each  
release, as well as developing the library, providing binary builds, and  
helping on the mailing lists. And, even, occasionally working on their  
own projects.

Sorry if this sounds bad-tempered, but there is no way that a small dev  
team can stop and work through several hundred pages worth of docs. This  
is partly why many Ruby GUI projects don’t have dedicated Ruby docs. I  
don’t think wxRuby’s are “rife” with errors, but because of the scale of  
the docs we’re reliant on users helping us and each other by pointing  
them out.

Patches to fix the docs are great  
([http://wxruby.rubyforge.org/wiki/wiki.pl?DocumentingWxRuby](http://wxruby.rubyforge.org/wiki/wiki.pl?DocumentingWxRuby)) but a  
simple list of references to all the mistakes you’ve found would be a  
massive help, and gratefully received.

> Also, the Wx::Sizer page has a broken link to “Sizer  
> overview”. Oh how I need that overview  
> Sizers are powerful, but not intuitive at first glance. You might have a  
> look at:  
> [http://wxruby.rubyforge.org/wiki/wiki.pl?Using\_Sizers\_For\_Layout](http://wxruby.rubyforge.org/wiki/wiki.pl?Using_Sizers_For_Layout)  
> [http://www.wxwidgets.org/manuals/stable/wx\_sizeroverview.html](http://www.wxwidgets.org/manuals/stable/wx_sizeroverview.html)

Alternatively, you might consider using XRC (XML layouts, designed in a  
visual editor) or the ‘layout’ library from WxSugar. Both of these  
enable you to get the benefits of Sizer-based layout, without having to  
deal with the slightly clumsy API.

cheers  
alex

---

<div class="post-metadata">

**Author:** ![unknown](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/u/4bbf92/32.png) [@unknown](https://www.ruby-forum.com/u/unknown)\
**Post date:** [October 26, 2007, 1:25am UTC](https://www.ruby-forum.com/t/api-doc-update-coming/118122/4 "2007-10-26T01:25:42Z")

</div>

Alex wrote:

> Sorry if this sounds bad-tempered, but there is no way that a small dev  
> team can stop and work through several hundred pages worth of docs…

No, no – _I_ apologize for sounding so snippy. I realize  
it’s a lot of work. (I’d pitch in if I didn’t have my own  
deadlines). Besides, the reponsiveness of this list more  
than makes up for the lag.

Thanks for the pointers to other docs.

Peralta
