summaryrefslogtreecommitdiff
path: root/io.c
diff options
context:
space:
mode:
authorstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-03-05 12:36:09 +0000
committerstomar <stomar@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2017-03-05 12:36:09 +0000
commit6af78021d42000045f4897c1a6d624b6b714f4f4 (patch)
tree7fb3e7a296e5c3713d2a28d3f0d1cc15e49d9908 /io.c
parent01fb6694238ba905a08b9331430d234da054cc63 (diff)
docs for IO#print
* io.c: [DOC] split documentation for IO#print into smaller paragraphs, delete duplicate sentence, fix call-seq. Based on a patch by Dario Daic. [ruby-core:78291] [Bug #12975] git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@57780 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'io.c')
-rw-r--r--io.c22
1 files changed, 12 insertions, 10 deletions
diff --git a/io.c b/io.c
index 7b258b0327..5acb1568f1 100644
--- a/io.c
+++ b/io.c
@@ -7012,18 +7012,20 @@ rb_f_printf(int argc, VALUE *argv)
/*
* call-seq:
- * ios.print() -> nil
+ * ios.print -> nil
* ios.print(obj, ...) -> nil
*
- * Writes the given object(s) to <em>ios</em>. The stream must be
- * opened for writing. If the output field separator (<code>$,</code>)
- * is not <code>nil</code>, it will be inserted between each object.
- * If the output record separator (<code>$\\</code>)
- * is not <code>nil</code>, it will be appended to the output. If no
- * arguments are given, prints <code>$_</code>. Objects that aren't
- * strings will be converted by calling their <code>to_s</code> method.
- * With no argument, prints the contents of the variable <code>$_</code>.
- * Returns <code>nil</code>.
+ * Writes the given object(s) to <em>ios</em>. Returns <code>nil</code>.
+ *
+ * The stream must be opened for writing.
+ * Each given object that isn't a string will be converted by calling
+ * its <code>to_s</code> method.
+ * When called without arguments, prints the contents of <code>$_</code>.
+ *
+ * If the output field separator (<code>$,</code>) is not <code>nil</code>,
+ * it is inserted between objects.
+ * If the output record separator (<code>$\\</code>) is not <code>nil</code>,
+ * it is appended to the output.
*
* $stdout.print("This is ", 100, " percent.\n")
*