Project

General

Profile

Bug #4756

Cleanup and enhance docs for PTY (patch included)

Added by davetron5000 (David Copeland) about 9 years ago. Updated about 8 years ago.

Status:
Closed
Priority:
Normal
Target version:
-
ruby -v:
ruby 1.9.3dev (2011-05-16 trunk 31583) [x86_64-darwin10.7.0]
Backport:
[ruby-core:36372]

Description

This cleans up and expands the PTY rdoc


Files

0002-Clean-up-docs-for-pty.patch (6.2 KB) 0002-Clean-up-docs-for-pty.patch davetron5000 (David Copeland), 05/22/2011 04:27 AM
#1

Updated by drbrain (Eric Hodel) about 9 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r31688.
David, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • ext/pty/pty.c: Improve documentaton. Patch by David Copeland. [Ruby 1.9 - Bug #4756]

Updated by drbrain (Eric Hodel) about 9 years ago

I told RDoc how to find the documentation for PTY::ChildExited like this:

/*

  • Document-class: PTY::ChildExited *
  • Thrown when PTY#check is called for a pid that represents a process that
  • has exited. */

Updated by mame (Yusuke Endoh) about 9 years ago

  • Status changed from Closed to Open

Hello,

 raise_from_check(cpid, status);
  • return Qnil; /* not reached */
  • return Qnil;

Please do not remove such a comment in a document patch.

raise_from_check always raises an exception, so this
return statement is not reached actually.

--
Yusuke Endoh mame@tsg.ne.jp

Updated by drbrain (Eric Hodel) about 9 years ago

Oops! I meant to keep the "not reached" comment when I reviewed this diff but it slipped my mind when I applied it.

#5

Updated by drbrain (Eric Hodel) about 9 years ago

  • Status changed from Open to Closed

This issue was solved with changeset r31877.
David, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.


  • ext/pty/pty.c (pty_check): Restore "not reached" comment. [Ruby 1.9 - Bug #4756]

Also available in: Atom PDF