added example, removed blank lines

railties/lib/rails/generators/actions.rb

@@ -69,6 +69,7 @@ module Rails
       # ==== Example
       #
       #   add_source "http://gems.github.com/"
+      #
       def add_source(source, options={})
         log :source, source
 
@@ -82,6 +83,16 @@ module Rails
       # If options :env is specified, the line is appended to the corresponding
       # file in config/environments.
       #
+      # ==== Examples
+      #
+      #   environment do
+      #     "config.autoload_paths += %W(#{config.root}/extras)"
+      #   end
+      #
+      #   environment(nil,:env => "development") do
+      #     "config.active_record.observers = :cacher"
+      #   end
+      #
       def environment(data=nil, options={}, &block)
         sentinel = /class [a-z_:]+ < Rails::Application/i
         env_file_sentinel = /::Application\.configure do/
@@ -160,13 +171,13 @@ module Rails
       #     <<-TASK
       #       namespace :#{project} do
       #         task :bootstrap do
-      #           puts "i like boots!"
+      #           puts "I like boots!"
       #         end
       #       end
       #     TASK
       #   end
       #
-      #   rakefile("seed.rake", "puts 'im plantin ur seedz'")
+      #   rakefile('seed.rake', 'puts "I'm planting your seeds"')
       #
       def rakefile(filename, data=nil, &block)
         log :rakefile, filename
@@ -265,7 +276,6 @@ module Rails
         # Define log for backwards compatibility. If just one argument is sent,
         # invoke say, otherwise invoke say_status. Differently from say and
         # similarly to say_status, this method respects the quiet? option given.
-        #
         def log(*args)
           if args.size == 1
             say args.first.to_s unless options.quiet?
@@ -276,7 +286,6 @@ module Rails
         end
 
         # Add an extension to the given name based on the platform.
-        #
         def extify(name)
           if RbConfig::CONFIG['host_os'] =~ /mswin|mingw/
             "#{name}.bat"

railties/lib/rails/generators/base.rb

@@ -248,7 +248,6 @@ module Rails
 
         # Check whether the given class names are already taken by user
         # application or Ruby on Rails.
-        #
         def class_collisions(*class_names) #:nodoc:
           return unless behavior == :invoke
 
@@ -275,13 +274,11 @@ module Rails
         end
 
         # Use Rails default banner.
-        #
         def self.banner
           "rails generate #{namespace.sub(/^rails:/,'')} #{self.arguments.map{ |a| a.usage }.join(' ')} [options]".gsub(/\s+/, ' ')
         end
 
         # Sets the base_name taking into account the current class namespace.
-        #
         def self.base_name
           @base_name ||= begin
             if base = name.to_s.split('::').first
@@ -292,7 +289,6 @@ module Rails
 
         # Removes the namespaces and get the generator name. For example,
         # Rails::Generators::ModelGenerator will return "model" as generator name.
-        #
         def self.generator_name
           @generator_name ||= begin
             if generator = name.to_s.split('::').last
@@ -304,20 +300,17 @@ module Rails
 
         # Return the default value for the option name given doing a lookup in
         # Rails::Generators.options.
-        #
         def self.default_value_for_option(name, options)
           default_for_option(Rails::Generators.options, name, options, options[:default])
         end
 
         # Return default aliases for the option name given doing a lookup in
         # Rails::Generators.aliases.
-        #
         def self.default_aliases_for_option(name, options)
           default_for_option(Rails::Generators.aliases, name, options, options[:aliases])
         end
 
         # Return default for the option name given doing a lookup in config.
-        #
         def self.default_for_option(config, name, options, default)
           if generator_name and c = config[generator_name.to_sym] and c.key?(name)
             c[name]
@@ -331,14 +324,12 @@ module Rails
         end
 
         # Keep hooks configuration that are used on prepare_for_invocation.
-        #
         def self.hooks #:nodoc:
           @hooks ||= from_superclass(:hooks, {})
         end
 
         # Prepare class invocation to search on Rails namespace if a previous
         # added hook is being used.
-        #
         def self.prepare_for_invocation(name, value) #:nodoc:
           return super unless value.is_a?(String) || value.is_a?(Symbol)
 
@@ -354,7 +345,6 @@ module Rails
 
         # Small macro to add ruby as an option to the generator with proper
         # default value plus an instance helper method called shebang.
-        #
         def self.add_shebang_option!
           class_option :ruby, :type => :string, :aliases => "-r", :default => Thor::Util.ruby_command,
                               :desc => "Path to the Ruby binary of your choice", :banner => "PATH"