Bug #4747: documentation updates: Curses and friends are 76% documented

• Status: Closed
• Assignee: drbrain (Eric Hodel)
• Target version: 1.9.3
• ruby -v: ruby 1.9.3dev (2011-05-20 trunk 31647) [x86_64-linux]

[vbatts (Vincent Batts)]

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.

[drbrain (Eric Hodel)]

• Status changed from Open to Closed
• % Done changed from 0 to 100

This issue was solved with changeset r31654.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• ext/.document: Add curses to documented extensions.
  • ext/curses/curses.c: Improve documentation. Patch by Vincent Batts.
    [Ruby 1.9 - Bug #4747]

[mame (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 [e-mail]

[drbrain (Eric Hodel)]

• Status changed from Open to Closed

This issue was solved with changeset r31730.
Vincent, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

---

• ext/curses/curses.c: Add missing documentation for button state, MIN
  and MAX comments. Add Curses. to TABSIZE= and ESCDELAY= methods.
  [Ruby 1.9 - Bug #4747]