Prev: rails errorm on FreeBSD-RELEASE
Next: Dont know where to look :(
From: Eric Hodel on 19 Apr 2010 13:22
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.
From: Jean-Julien Fleck on 19 Apr 2010 14:58
Hello Eric,

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

Because my boss does not wish to :o)

> 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.

What I would like to give to my (3) coworkers is a Rakefile (designed
to handle book's compilation in LaTeX and ensure all the data needed
to make the books have been gathered and up to date) and an online
documentation (using your tool for which I'm very grateful). They
would not have to compile the doc themselves. And the Rakefile has to
be concise with the tasks descriptions because the very last person to
use it (my boss) should be able to spot the right task to compile all
the books at once in the right format (even if the editing process the
intermediate tasks are very useful for us).

I've documented all the tasks in the comments but opening the Rakefile
to read them is quite tedious and not really productive enough.
Knowing rdoc, I was just surprised nothing of the kind existed with
Rakefiles, hence my questions.

Could you tell me where I should look in order to modify a bit
rdoc-rake to make it do what I want ?

Cheers,

--
JJ Fleck
PCSI1 Lycée Kléber

From: Joel VanderWerf on 19 Apr 2010 15:59
Jean-Julien Fleck wrote:
> And the Rakefile has to
> be concise with the tasks descriptions because the very last person to
> use it (my boss) should be able to spot the right task to compile all
> the books at once in the right format (even if the editing process the
> intermediate tasks are very useful for us).

Maybe the best solution to your problem is by changing rake, not rdoc.

Regardless of what happens to rdoc, it would be nice if rake had some
options for suppressing infrequently used targets, particularly ones in
namespaces. The --tasks option isn't quite it:

-T, --tasks [PATTERN] Display the tasks (matching
optional PATTERN) with descriptions, then exit.

This is great it you want to see *only* those tasks in some namespace
(or with a specific file extension). But it would be nice if there were
also something like

--top-tasks Display only the top-level tasks
(not in a namespace).

Then, you could put all your intermediate tasks in namespaces to hide
them from end users.

In the meantime, you can define a little task to do it for you:

task "top-tasks" do
`rake --tasks`.split("\n").each do |t|
if t !~ /^rake \w+:/ and t =~ /^rake/
puts t
end
end
end

Maybe you can even use Rake's API to get the task list without shelling out.

From: Robert Dober on 19 Apr 2010 18:59
On Mon, Apr 19, 2010 at 9:59 PM, Joel VanderWerf
<joelvanderwerf(a)gmail.com> wrote:
<snip>
> task "top-tasks" do
>  `rake --tasks`.split("\n").each do |t|
>    if t !~ /^rake \w+:/ and t =~ /^rake/
>      puts t
>    end
>  end
> end
>
> Maybe you can even use Rake's API to get the task list without shelling out.
>
>
task ":top-tasks" do
Rake::Task.tasks.each do | tsk |
next if tsk.name =~ /:/ # this could be more elaborate I guess
puts "#{tsk.name} #{tsk.full_comment}"
end
end

use with

rake :top-tasks ( just to distinguish from "normal" tasks ) I am too
lazy to tweak the rake script to allow
rake --top-tasks.

HTH
Robert


--
The best way to predict the future is to invent it.
-- Alan Kay

From: Joel VanderWerf on 19 Apr 2010 19:17
Robert Dober wrote:
> On Mon, Apr 19, 2010 at 9:59 PM, Joel VanderWerf
> <joelvanderwerf(a)gmail.com> wrote:
> <snip>
>> task "top-tasks" do
>> `rake --tasks`.split("\n").each do |t|
>> if t !~ /^rake \w+:/ and t =~ /^rake/
>> puts t
>> end
>> end
>> end
>>
>> Maybe you can even use Rake's API to get the task list without shelling out.
>>
>>
> task ":top-tasks" do
> Rake::Task.tasks.each do | tsk |
> next if tsk.name =~ /:/ # this could be more elaborate I guess
> puts "#{tsk.name} #{tsk.full_comment}"
> end
> end
>
> use with
>
> rake :top-tasks ( just to distinguish from "normal" tasks ) I am too
> lazy to tweak the rake script to allow
> rake --top-tasks.

Thanks, Robert!

Actually, I like

rake top-tasks

better than

rake --top-tasks

anyway.

It might be better to skip the tasks that have no desc:

task "top-tasks" do
Rake::Task.tasks.each do | tsk |
next if tsk.name =~ /:/ or not tsk.full_comment
puts "#{tsk.name} #{tsk.full_comment}"
end
end

First  |  Prev  |  Next  |  Last
Pages: 1 2 3
Prev: rails errorm on FreeBSD-RELEASE
Next: Dont know where to look :(