# Please review documentation style for deprecated methods

**URL:** <https://www.ruby-forum.com/t/please-review-documentation-style-for-deprecated-methods/149947>\
**Category:** Ruby-Gnome 2\
**Created:** [October 1, 2008, 12:52pm UTC](https://www.ruby-forum.com/t/please-review-documentation-style-for-deprecated-methods/149947 "2008-10-01T12:52:58Z")\
**Posts on this page:** 2\
**Page:** 1

<div class="post-metadata">

**Author:** ![royw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/e9bcb4/32.png) [@royw](https://www.ruby-forum.com/u/royw)\
**Post date:** [October 1, 2008, 12:52pm UTC](https://www.ruby-forum.com/t/please-review-documentation-style-for-deprecated-methods/149947/1 "2008-10-01T12:52:58Z")

</div>

Howdy,

I did a major update to the Gtk::Toolbar class documentation  
([http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3AToolbar](http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3AToolbar)) in an  
attempt to clarify what is deprecated. I used  
[http://library.gnome.org/devel/gtk/stable/GtkToolbar.html](http://library.gnome.org/devel/gtk/stable/GtkToolbar.html) as the primary  
source with a couple of trips to irb. Please review mainly for  
documentation style.

Thank you,  
Roy

---

<div class="post-metadata">

**Author:** ![royw](https://www.ruby-forum.com/letter_avatar_proxy/v4/letter/r/e9bcb4/32.png) [@royw](https://www.ruby-forum.com/u/royw)\
**Post date:** [October 5, 2008, 3:46am UTC](https://www.ruby-forum.com/t/please-review-documentation-style-for-deprecated-methods/149947/2 "2008-10-05T03:46:56Z")

</div>

Hi,

In [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid)  
“[ruby-gnome2-devel-en] Please review documentation style for  
deprecated methods…” on Wed, 1 Oct 2008 12:52:58 +0200,  
Roy W. [removed\_email\_address@domain.invalid](mailto:removed_email_address@domain.invalid) wrote:

> I did a major update to the Gtk::Toolbar class documentation

Great!

> ([http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3AToolbar](http://ruby-gnome2.sourceforge.jp/hiki.cgi?Gtk%3A%3AToolbar)) in an  
> attempt to clarify what is deprecated. I used  
> [Learn GNOME](http://library.gnome.org/devel/gtk/stable/GtkToolbar.html) as the primary  
> source with a couple of trips to irb. Please review mainly for  
> documentation style.

In other pages, we place "((_Since XXX_))’ mark to the end  
of description section not behind return value section:

Our style:  
— some\_method(…)

```
   description... ((*Since XXX*))

   * arg1: ...
   * ...
   * Returns: ...

```

Your style:

— some\_method(…)

```
   description...

   * arg1: ...
   * ...
   * Returns: ...

   ((*Since XXX*))

```

It’ll be better that we use same style. Could you use our  
style if you don’t have objection?

## Thanks,

kou
