[DOC] Enhanced RDoc for IO #5307
Conversation
io.c
Outdated
| * system and is not buffered by Ruby internally. See also | ||
| * IO#fsync. | ||
| * Returns the value of the most recent call to IO#sync=, | ||
| * or +false+ if the method has not been called; see IO#sync=: |
There was a problem hiding this comment.
The previous language was more accurate. There are cases where the sync mode is set without IO#sync= (such as on the write pipe returned by IO.pipe). I would continue to state that this returns the sync mode, even if you only define the sync mode in IO#sync=
io.c
Outdated
| @@ -2630,22 +2650,23 @@ rb_io_descriptor(VALUE io) | |||
|
|
|||
| /* | |||
| * call-seq: | |||
| * ios.pid -> integer | |||
| * pid -> integer | |||
There was a problem hiding this comment.
integer or nil
Somewhere in the description, we should describe that this returns nil for instances not created by IO.popen.
There was a problem hiding this comment.
Done. I saw the nil in the previous doc, but could not figure out when it occurs.
There was a problem hiding this comment.
I think the call-seq should still be updated to say integer or nil.
io.c
Outdated
| @@ -2630,22 +2650,23 @@ rb_io_descriptor(VALUE io) | |||
|
|
|||
| /* | |||
| * call-seq: | |||
| * ios.pid -> integer | |||
| * pid -> integer | |||
There was a problem hiding this comment.
I think the call-seq should still be updated to say integer or nil.
Treated: