aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails_generator/generators/components/scaffold/USAGE
diff options
context:
space:
mode:
authorCheah Chu Yeow <chuyeow@gmail.com>2008-05-31 13:46:02 -0700
committerCheah Chu Yeow <chuyeow@gmail.com>2008-05-31 13:46:02 -0700
commiteb007e4197d6b6513e5accda79cf7edc3d773888 (patch)
tree0a1266d83328e61a843e754e931401696d5679ae /railties/lib/rails_generator/generators/components/scaffold/USAGE
parent60e37868e40ac11f07cbda81f24dcdb0a9c68783 (diff)
downloadrails-eb007e4197d6b6513e5accda79cf7edc3d773888.tar.gz
rails-eb007e4197d6b6513e5accda79cf7edc3d773888.tar.bz2
rails-eb007e4197d6b6513e5accda79cf7edc3d773888.zip
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.
Diffstat (limited to 'railties/lib/rails_generator/generators/components/scaffold/USAGE')
-rw-r--r--railties/lib/rails_generator/generators/components/scaffold/USAGE14
1 files changed, 9 insertions, 5 deletions
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`