How to add documentation or comment in RakeFile

Question

I have one Rakefile:

desc 'submodulePull'
task :submodulePull do
  sh 'git submodule update'
  sh 'git submodule foreach git pull'
end

I want to add description about submodulePull work.

How do I add documentation/comment/description about command in RakeFile that should ignore by compiler @run time.

Answer 1

You're already doing it -- that's what desc is, which stands for description.