Re: 2nd try at date/format.rb & pty.c
Eric Hodel <[email protected]>
| Newsgroups | gmane.comp.lang.ruby.documentation |
|---|---|
| Message-ID | <[email protected]> |
On Aug 19, 2006, at 8:29 AM, Mat Schaffer wrote:
> 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.
>>
>> 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'.
Adding -u to cvs diff is the magic flag.
>> 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?
Two spaces, just like in the ruby files.
>> 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.
Cool, looking forward to it!
--
Eric Hodel - [email protected] - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant
http://trackmap.robotcoop.com