[ruby/io-console] [DOC] Add documentation for IO#cursor

ruby/io-console#50 ruby/io-console@ee752ce771
ruby · Dec 7, 2023 · d69af47 · d69af47
1 parent 2e9329e
commit d69af47
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/ext/io/console/console.c b/ext/io/console/console.c
@@ -1152,6 +1152,16 @@ console_scroll(VALUE io, int line)
 # define console_key_pressed_p rb_f_notimplement
 #endif
 
+/*
+ * call-seq:
+ *   io.cursor -> [row, column]
+ *
+ * Returns the current cursor position as a two-element array of integers (row, column)
+ *
+ *   io.cursor # => [3, 5]
+ *
+ * You must require 'io/console' to use this method.
+ */
 static VALUE
 console_cursor_pos(VALUE io)
 {