Re: 2nd try at date/format.rb & pty.c

Mat Schaffer <[email protected]>
Newsgroups gmane.comp.lang.ruby.documentation
Message-ID <[email protected]>
On Aug 18, 2006, at 8:25 PM, Eric Hodel wrote:
> On Aug 18, 2006, at 3:02 PM, Mat Schaffer wrote:
>> I have two patches.  The first is another try at the documentation  
>> for date/format.rb.  Hopefully it's acceptable this time.  The  
>> other is for pty.c.  I checked both of them with stdlib-doc and  
>> they work fine.  But the link on the left frame for pty still  
>> links to shl.rb.  I'm not sure how to make it point to the PTY  
>> class docs.
>>
>> Anyway, let me know what you think.
>
> These patches appear to be against ruby_1_8.  Please send patches  
> against HEAD.  If backporting to ruby_1_8 is non-trivial,
> please supply a separate patch for ruby_1_8.  I can handle trivial  
> backporting.
I'll check out HEAD, find out and let you know.

> Documentation must be wrapped to 80 characters.
>
> Please send unified diffs.
What do I use to create unified diffs?  These were from eclipse but  
identical to the output of 'cvs diff'.

> pty_doc.diff:
>
> >  * PTY.getpty("command") do |output, input, pid|
> >  *   # At this point output and input are the command's output  
> and input stream, respectively.  pid is the command's process ID.
> >  * end
>
> This should be indented to turn it into a code block.
How far should it be indented and does HTML <code> qualify as a code  
block?

> Those aren't just documentation changes.
Good catch there.  Must have gotten something screwed up since there  
was an update between my first and second try and I tried to merge  
them appropriately.  I'll do it again on HEAD and hopefully it'll  
come out right.
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.