Generator Names about rdoc HOT 2 CLOSED

I don't see the need to have different generator names from the class name. Generator names should be short and simple so they're easy for the user to type after -f, and so should the class name.

The example in the documentation does not produce "generator":

irb> My::Awesome::Generator.name.sub(/^RDoc::Generator::/, '').downcase
=> "my::awesome::generator"

from rdoc.

My mistake, my::awesome::generator is what I meant to put.

I have written a few generators, and as I do with any project, I was writing the code thusly:

# lib/coolname/generator.rb
module CoolName
  class Generator
    ...
  end
end

So that my project has proper namespace. But I obviously don't want the format to be coolname::generator, I just want it to be coolname. That is why one might want the format name to differ from the class name.

In any case it's not that big a deal since one can just hack around it by redefining the name class method. On the hand, b/c of this issue I'm now inclined to just name the classes RDoc::Generator::CoolName -- I'm not sure how that fairs for best practices, but it seems to be what RDoc wants me to do given the definition of #add_generator.

from rdoc.