Bug #4747

documentation updates: Curses and friends are 76% documented

Added by Vincent Batts almost 3 years ago. Updated almost 3 years ago.

[ruby-core:36352]
Status:Closed
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] Backport:

Description

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.

ruby_doc_updates-20110520_0227-curses_vbatts.patch Magnifier (46.7 KB) Vincent Batts, 05/20/2011 03:34 PM

Associated revisions

Revision 31654
Added by Eric Hodel almost 3 years ago

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

Revision 31730
Added by Eric Hodel almost 3 years ago

  • 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]

History

#1 Updated by Eric Hodel almost 3 years ago

  • 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]

#2 Updated by Yusuke Endoh almost 3 years ago

  • 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

#3 Updated by Eric Hodel almost 3 years ago

  • 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]

Also available in: Atom PDF