Re: Documentation roadmap?

Eric Hodel <[email protected]> Fri, 25 Aug 2006 13:22:00 -0700
Newsgroups gmane.comp.lang.ruby.documentation
Message-ID <[email protected]>
On Aug 25, 2006, at 5:12 AM, Mat Schaffer wrote:
> On Aug 25, 2006, at 3:08 AM, Eric Hodel wrote:
>> On Aug 23, 2006, at 8:35 PM, Mat Schaffer wrote:
>>> On Aug 23, 2006, at 12:13 PM, James Britt wrote:
>>>> Mat Schaffer wrote:
>>>>> Not quite.  More like roadmaps for rdoc features or stdlib-doc  
>>>>> features.
>>>>> Like the syntax hilighting seems like an rdoc enhancement,  
>>>>> whereas a  rake task to automate common documentation tasks  
>>>>> seems like a stdlib- doc enhancement.
>>>>
>>>> I don't think there is such a thing.    I think the plan has  
>>>> simply been "Write more docs."
>>>> I also don't think there are enhancements planned for rdoc, but  
>>>> Eric would know about that.
>>>
>>> First, anyone know where the official rdoc source is?  I see it  
>>> in the ruby tree, but also at sf.net.
>>
>> The official source ships with Ruby.
>>
>> There are plans for RDoc improvement, but so far are minor.   
>> Adding the file name where the documentation came from, for example.
>
> If someone came up with a patch to do syntax hilighting on the  
> embedded source code, do you think it could have a chance to make  
> it into the distribution?

I don't know.  The code would have to be self-contained without  
dependencies.

-- 
Eric Hodel - [email protected] - http://blog.segment7.net
This implementation is HODEL-HASH-9600 compliant

http://trackmap.robotcoop.com