* ext/curses/curses.c: [DOC] Cleaned up formatting consistency of rdoc

comments for Curses, including period spacing and column width.

  This patch also fixed some typos. Thanks to @postmodern for the patch!
  [Fixes GH-420] https://github.com/ruby/ruby/pull/420


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@43316 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

ChangeLog

@@ -1,3 +1,11 @@
+Thu Oct 17 07:10:26 2013  Zachary Scott  <e@zzak.io>
+
+	* ext/curses/curses.c: [DOC] Cleaned up formatting consistency of rdoc
+	  comments for Curses, including period spacing and column width.
+
+	  This patch also fixed some typos. Thanks to @postmodern for the patch!
+	  [Fixes GH-420] https://github.com/ruby/ruby/pull/420
+
 Thu Oct 17 06:58:42 2013  Zachary Scott  <e@zzak.io>
 
 	* ext/date/date_core.c: [DOC] plural grammar fixed by @scott113341

ext/curses/curses.c

@@ -694,7 +694,7 @@ getstr_func(void *arg)
 /*
  * Document-method: Curses.getstr
  *
- * This is equivalent to a series f Curses::Window.getch calls
+ * This is equivalent to a series of Curses::Window.getch calls
  *
  */
 static VALUE
@@ -1301,7 +1301,8 @@ static const rb_data_type_t mousedata_type = {
  *
  * This will read and pop the mouse event data off the queue
  *
- * See the BUTTON*, ALL_MOUSE_EVENTS and REPORT_MOUSE_POSITION constants, to examine the mask of the event
+ * See the BUTTON*, ALL_MOUSE_EVENTS and REPORT_MOUSE_POSITION constants,
+ * to examine the mask of the event
  */
 static VALUE
 curses_getmouse(VALUE obj)
@@ -1488,7 +1489,8 @@ window_s_allocate(VALUE class)
  * call-seq: new(height, width, top, left)
  *
  * Construct a new Curses::Window with constraints of
- * +height+ lines, +width+ columns, begin at +top+ line, and begin +left+ most column.
+ * +height+ lines, +width+ columns, begin at +top+ line, and begin +left+ most
+ * column.
  *
  * A new window using full screen is called as
  * 	Curses::Window.new(0,0,0,0)
@@ -1514,8 +1516,9 @@ window_initialize(VALUE obj, VALUE h, VALUE w, VALUE top, VALUE left)
  * Document-method: Curses::Window.subwin
  * call-seq: subwin(height, width, top, left)
  *
- * Construct a new subwindow with constraints of
+ * Construct a new sub-window with constraints of
- * +height+ lines, +width+ columns, begin at +top+ line, and begin +left+ most column.
+ * +height+ lines, +width+ columns, begin at +top+ line, and begin +left+ most
+ * column.
  *
  */
 static VALUE
@@ -1665,7 +1668,7 @@ window_setpos(VALUE obj, VALUE y, VALUE x)
 /*
  * Document-method: Curses::Window.cury
  *
- * A getter for the current line (Y coord) of the window
+ * A getter for the current line (Y coordinate) of the window
  */
 static VALUE
 window_cury(VALUE obj)
@@ -1681,7 +1684,7 @@ window_cury(VALUE obj)
 /*
  * Document-method: Curses::Window.curx
  *
- * A getter for the current column (X coord) of the window
+ * A getter for the current column (X coordinate) of the window
  */
 static VALUE
 window_curx(VALUE obj)
@@ -1745,7 +1748,7 @@ window_maxx(VALUE obj)
 /*
  * Document-method: Curses::Window.begy
  *
- * A getter for the beginning line (Y coord) of the window
+ * A getter for the beginning line (Y coordinate) of the window
  */
 static VALUE
 window_begy(VALUE obj)
@@ -1765,7 +1768,7 @@ window_begy(VALUE obj)
 /*
  * Document-method: Curses::Window.begx
  *
- * A getter for the beginning column (X coord) of the window
+ * A getter for the beginning column (X coordinate) of the window
  */
 static VALUE
 window_begx(VALUE obj)
@@ -1882,7 +1885,8 @@ window_inch(VALUE obj)
  * Document-method: Curses::Window.addch
  * call-seq: addch(ch)
  *
- * Add a character +ch+, with attributes, to the window, then advance the cursor.
+ * Add a character +ch+, with attributes, to the window, then advance the
+ * cursor.
  *
  * see also the system manual for curs_addch(3)
  */
@@ -2014,7 +2018,7 @@ wgetstr_func(void *_arg)
 /*
  * Document-method: Curses::Window.getstr
  *
- * This is equivalent to a series f Curses::Window.getch calls
+ * This is equivalent to a series of Curses::Window.getch calls
  *
  */
 static VALUE
@@ -2119,7 +2123,8 @@ window_scrollok(VALUE obj, VALUE bf)
  *
  * It is disabled by default because insert/delete line tends to be visually
  * annoying when used in applications where it is not really needed.
- * If insert/delete line cannot be used, curses redraws the changed portions of all lines.
+ * If insert/delete line cannot be used, curses redraws the changed portions of
+ * all lines.
  *
  */
 static VALUE
@@ -2482,9 +2487,12 @@ window_nodelay(VALUE obj, VALUE val)
  * call-seq: timeout=(delay)
  *
  * Sets block and non-blocking reads for the window.
- * - If delay is negative, blocking read is used (i.e., waits indefinitely for input).
+ * - If delay is negative, blocking read is used (i.e., waits indefinitely for
- * - If delay is zero, then non-blocking read is used (i.e., read returns ERR if no input is waiting).
+ *   input).
- * - If delay is positive, then read blocks for delay milliseconds, and returns ERR if there is still no input.
+ * - If delay is zero, then non-blocking read is used (i.e., read returns ERR
+ *   if no input is waiting).
+ * - If delay is positive, then read blocks for delay milliseconds, and returns
+ *   ERR if there is still no input.
  *
  */
 static VALUE