From eb007e4197d6b6513e5accda79cf7edc3d773888 Mon Sep 17 00:00:00 2001
From: Cheah Chu Yeow <chuyeow@gmail.com>
Date: Sat, 31 May 2008 13:46:02 -0700
Subject: Make a note about script/destroy in 'script/generate scaffold' usage
 description. Make a note about 'script/generate scaffold' requiring a
 singular model name. Remove :nodoc: for a documented method.

---
 .../rails_generator/generators/components/scaffold/USAGE   | 14 +++++++++-----
 railties/lib/rails_generator/scripts/destroy.rb            | 13 ++++++-------
 2 files changed, 15 insertions(+), 12 deletions(-)

(limited to 'railties/lib')

diff --git a/railties/lib/rails_generator/generators/components/scaffold/USAGE b/railties/lib/rails_generator/generators/components/scaffold/USAGE
index a0e4baea08..810aea16f1 100644
--- a/railties/lib/rails_generator/generators/components/scaffold/USAGE
+++ b/railties/lib/rails_generator/generators/components/scaffold/USAGE
@@ -1,10 +1,11 @@
 Description:
     Scaffolds an entire resource, from model and migration to controller and
     views, along with a full test suite. The resource is ready to use as a
-    starting point for your restful, resource-oriented application.
+    starting point for your RESTful, resource-oriented application.
 
-    Pass the name of the model, either CamelCased or under_scored, as the first
-    argument, and an optional list of attribute pairs.
+    Pass the name of the model (in singular form), either CamelCased or
+    under_scored, as the first argument, and an optional list of attribute
+    pairs.
 
     Attribute pairs are column_name:sql_type arguments specifying the
     model's attributes. Timestamps are added by default, so you don't have to
@@ -13,13 +14,16 @@ Description:
     You don't have to think up every attribute up front, but it helps to
     sketch out a few so you can start working with the resource immediately.
 
-    For example, `scaffold post title:string body:text published:boolean`
+    For example, 'scaffold post title:string body:text published:boolean'
     gives you a model with those three attributes, a controller that handles
     the create/show/update/destroy, forms to create and edit your posts, and
     an index that lists them all, as well as a map.resources :posts
     declaration in config/routes.rb.
 
+    If you want to remove all the generated files, run
+    'script/destroy scaffold ModelName'.
+
 Examples:
-    `./script/generate scaffold post` # no attributes, view will be anemic
+    `./script/generate scaffold post`
     `./script/generate scaffold post title:string body:text published:boolean`
     `./script/generate scaffold purchase order_id:integer amount:decimal`
diff --git a/railties/lib/rails_generator/scripts/destroy.rb b/railties/lib/rails_generator/scripts/destroy.rb
index 4fcbc3e0df..a7c2a14751 100644
--- a/railties/lib/rails_generator/scripts/destroy.rb
+++ b/railties/lib/rails_generator/scripts/destroy.rb
@@ -3,7 +3,7 @@ require File.dirname(__FILE__) + '/../scripts'
 module Rails::Generator::Scripts
   class Destroy < Base
     mandatory_options :command => :destroy
-    
+
     protected
     def usage_message
       usage = "\nInstalled Generators\n"
@@ -15,14 +15,13 @@ module Rails::Generator::Scripts
 
       usage << <<end_blurb
 
-This script will destroy all files created by the corresponding 
-script/generate command. For instance, script/destroy migration CreatePost
-will delete the appropriate ###_create_post.rb file in db/migrate, while 
-script/destroy scaffold Post will delete the posts controller and 
+script/generate command. For instance, 'script/destroy migration CreatePost'
+will delete the appropriate XXX_create_post.rb migration file in db/migrate,
+while 'script/destroy scaffold Post' will delete the posts controller and
 views, post model and migration, all associated tests, and the map.resources
 :posts line in config/routes.rb.
-      
-For instructions on finding new generators, run script/generate
+
+For instructions on finding new generators, run script/generate.
 end_blurb
       return usage
     end
-- 
cgit v1.2.3