From: Eric Hodel <drbrain@...7.net>
Date: 2010-04-20T02:22:14+09:00
Subject: Re: Documenting Rakefile using rdoc

On Apr 19, 2010, at 07:11, Jean-Julien Fleck wrote:

> Hello Eric,
> 
>> Check it out:
>> 
>>  gem install rdoc-rake
> 
> Thanks, it's at least a beginning and make the code appear easily but
> would it be possible to have a Rakefile like this:
> 
> ***********
> ##
> # Undescribed task that could come in handy and with comments that should be
> # included in rdoc
> 
> task :undescribed
>  puts "Doing some stuff"
> end
> 
> ##
> # Described task so that rake -T works
> 
> desc "Described task"
> task :described
>  puts "Doing some other stuff"
> end
> 
> ***********
> 
> And make the comment appear in the doc and not only the one in the
> 'desc' attribute ?

If it could come in handy why isn't it documented with a desc?

Hiding documentation behind a separate tool (rdoc-rake) that nobody knows about (just released yesterday) and mostly sucks (honestly, I only released it because you had an interest) is hostile to your users.