From: Yusuke Endoh <mame@...>
Date: 2011-05-24T21:42:12+09:00
Subject: [ruby-core:36424] [Ruby 1.9 - Bug #4747][Open] documentation updates: Curses and friends are 76% documented


Issue #4747 has been updated by Yusuke Endoh.

Status changed from Closed to Open

Hello,

I think

+ * call-seq: TABSIZE=(value)

should be

+ * call-seq: Curses.TABSIZE=(value)

.  The same goes for ESCDELAY=.
Personally, I like to write a receiver in all call-seq, like

+ * call-seq: box(vert, hor)

to

+ * call-seq: win.box(vert, hor)

.


In addition,

+/*
+ * Document-method: Curses::MouseEvent.bstate
+ *
+ * Returns the current mouse's B state.
+ *
+ * ???
+ */

+    /* Document-const: MIN
+     *
+     * ???
+     */

+    /* Document-const: MAX
+     *
+     * ???
+     */

Please sweep :-)

-- 
Yusuke Endoh <mame@tsg.ne.jp>
----------------------------------------
Bug #4747: documentation updates: Curses and friends are 76% documented
http://redmine.ruby-lang.org/issues/4747

Author: Vincent Batts
Status: Open
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 1.9.3
ruby -v: ruby 1.9.3dev (2011-05-20 trunk 31647) [x86_64-linux]


attached is a patch with a *lot* of additions the curses library.
In fact, before, there was not much more than a simple effort to do call-seq: for a handful of methods.

This makes the following:
Curses::MouseEvent 100%
Curses::Window     100%
Curses::Key        100%

Curses ... in process

Anywho, the remaining 24% should be along shortly.


-- 
http://redmine.ruby-lang.org