summaryrefslogtreecommitdiff
path: root/ext
diff options
context:
space:
mode:
authordrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-04-18 23:59:22 +0000
committerdrbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2012-04-18 23:59:22 +0000
commit6878e597c4412e5b5ca2539ed74ddd2455576f50 (patch)
tree41c56371f0e9f9066aa2dafc53a81aea6a3d5a3f /ext
parentab0eb272f9e73123211574081aa8a0943678d80d (diff)
* ext/curses/curses.c (window_nodelay): Fixed call-seq of nodelay to
include the '='. Improved description window.nodelay=. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@35392 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext')
-rw-r--r--ext/curses/curses.c9
1 files changed, 6 insertions, 3 deletions
diff --git a/ext/curses/curses.c b/ext/curses/curses.c
index 132c7e96dff..1dcf5e94713 100644
--- a/ext/curses/curses.c
+++ b/ext/curses/curses.c
@@ -2439,11 +2439,14 @@ window_keypad(VALUE obj, VALUE val)
#ifdef HAVE_NODELAY
/*
* Document-method: Curses::Window.nodelay
- * call-seq: nodelay(bool)
+ * call-seq:
+ * window.nodelay = bool
*
- * Causes Curses::Window.getch to be a non-blocking call. If no input is ready, getch returns ERR.
+ * When in no-delay mode Curses::Window#getch is a non-blocking call. If no
+ * input is ready #getch returns ERR.
*
- * If disabled (+bool+ is +false+), Curses::Window.getch waits until a key is pressed.
+ * When in delay mode (+bool+ is +false+ which is the default),
+ * Curses::Window#getch blocks until a key is pressed.
*
*/
static VALUE