Please review documentation style for deprecated methods

Desktop Ruby-Gnome 2
1

Howdy,

I did a major update to the Gtk::Toolbar class documentation
(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 as the primary
source with a couple of trips to irb. Please review mainly for
documentation style.

Thank you,
Roy

2

Hi,

In [email protected]
“[ruby-gnome2-devel-en] Please review documentation style for
deprecated methods…” on Wed, 1 Oct 2008 12:52:58 +0200,
Roy W. [email protected] wrote:

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

Great!

(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 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