Bug #4748: documentation updates: Curses and friends are 100% documented - Ruby master - Ruby Issue Tracking System

Actions

Copy link

Bug #4748

closed

documentation updates: Curses and friends are 100% documented

Added by vbatts (Vincent Batts) almost 13 years ago. Updated almost 13 years ago.

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]

Backport:

[ruby-core:36355]

Description

well 100% per the rdoc report.
Sadly there are a host of constants that are not being picked up by RDoc (I intend to follow up on that)

Files

Download all files

ruby_doc_updates-20110520_1648-curses_vbatts.patch (21.3 KB) ruby_doc_updates-20110520_1648-curses_vbatts.patch		vbatts (Vincent Batts), 05/21/2011 05:55 AM
ruby_doc_updates-20110613_update-curses_vbatts.patch (34 KB) ruby_doc_updates-20110613_update-curses_vbatts.patch		vbatts (Vincent Batts), 06/14/2011 05:39 AM

Actions

Copy link

Updated by drbrain (Eric Hodel) almost 13 years ago

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

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

ext/curses/curses.c: Complete documentation. Patch by Vincent
Batts. [Ruby 1.9 - Bug #4748]

Actions

Copy link

#2 [ruby-core:36426]

Updated by mame (Yusuke Endoh) almost 13 years ago

Status changed from Closed to Open

Hello,

- === Constants
- For whatever reason, these are not picked up in the RDoc
- These are Integer of the colors.
- - COLOR_BLACK = 0
- - COLOR_RED = 1
- - COLOR_GREEN = 2
- - COLOR_YELLOW = 3
- - COLOR_BLUE = 4
- - COLOR_MAGENTA = 5
- - COLOR_CYAN = 6
- - COLOR_WHITE = 7

These actual values must not be documented.

These constants just export ones of curses.h.
Some environments have a different integer set. For example,
I heard that COLOR_RED is 4 in windows.
In addition, Ruby curses library can change the actual value in
future. For example, it might be better for such a constant to
have a Symbol.

/*
```
* Document-const: Curses::COLOR_BLACK
```
```
*
```
```
* Integer of the color black
```
```
*/
```

For the same reason, "Integer" should not be mentioned.

--
Yusuke Endoh mame@tsg.ne.jp

Actions

Copy link

Updated by drbrain (Eric Hodel) almost 13 years ago

Status changed from Open to Closed

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