diff options
| -rw-r--r-- | railties/lib/generators/rails/controller/USAGE | 15 | ||||
| -rw-r--r-- | railties/lib/generators/rails/helper/USAGE | 15 | ||||
| -rw-r--r-- | railties/lib/generators/rails/integration_test/USAGE | 6 | ||||
| -rw-r--r-- | railties/lib/generators/rails/mailer/USAGE | 4 | ||||
| -rw-r--r-- | railties/lib/generators/rails/observer/USAGE | 4 | ||||
| -rw-r--r-- | railties/lib/generators/rails/performance_test/USAGE | 6 |
6 files changed, 18 insertions, 32 deletions
diff --git a/railties/lib/generators/rails/controller/USAGE b/railties/lib/generators/rails/controller/USAGE index 42d38bd745..b714d061d2 100644 --- a/railties/lib/generators/rails/controller/USAGE +++ b/railties/lib/generators/rails/controller/USAGE @@ -5,9 +5,8 @@ Description: To create a controller within a module, specify the controller name as a path like 'parent_module/controller_name'. - This generates a controller class in app/controllers, view templates in - app/views/controller_name and then invokes the helper generator, the - current template engine and finally the test framework. + This generates a controller class in app/controllers and invokes helper, + template engine and test framework generators. Example: `./script/generate controller CreditCard open debit credit close` @@ -18,13 +17,3 @@ Example: Views: app/views/credit_card/debit.html.erb [...] Helper: app/helpers/credit_card_helper.rb Helper Test: test/unit/helpers/credit_card_helper_test.rb - -Modules Example: - `./script/generate controller 'admin/credit_card' suspend late_fee` - - Credit card admin controller with URLs /admin/credit_card/suspend. - Controller: app/controllers/admin/credit_card_controller.rb - Functional Test: test/functional/admin/credit_card_controller_test.rb - Views: app/views/admin/credit_card/debit.html.erb [...] - Helper: app/helpers/admin/credit_card_helper.rb - Helper Test: test/unit/helpers/admin/credit_card_helper_test.rb diff --git a/railties/lib/generators/rails/helper/USAGE b/railties/lib/generators/rails/helper/USAGE index e74d4b6425..531c9b390a 100644 --- a/railties/lib/generators/rails/helper/USAGE +++ b/railties/lib/generators/rails/helper/USAGE @@ -1,12 +1,12 @@ Description: - Stubs out a new helper. Pass the helper name, either - CamelCased or under_scored. + Stubs out a new helper. Pass the helper name, either CamelCased + or under_scored. To create a helper within a module, specify the helper name as a path like 'parent_module/helper_name'. - This generates a helper class in app/helpers and invokes your test - framework. + This generates a helper class in app/helpers and invokes the configured + test framework. Example: `./script/generate helper CreditCard` @@ -15,10 +15,3 @@ Example: Helper: app/helpers/credit_card_helper.rb Test: test/unit/helpers/credit_card_helper_test.rb -Modules Example: - `./script/generate helper 'admin/credit_card'` - - Credit card admin helper. - Helper: app/helpers/admin/credit_card_helper.rb - Test: test/unit/helpers/admin/credit_card_helper_test.rb - diff --git a/railties/lib/generators/rails/integration_test/USAGE b/railties/lib/generators/rails/integration_test/USAGE index 09e2691f69..b76c35a702 100644 --- a/railties/lib/generators/rails/integration_test/USAGE +++ b/railties/lib/generators/rails/integration_test/USAGE @@ -1,7 +1,9 @@ Description: Stubs out a new integration test. Pass the name of the test, either - CamelCased or under_scored, as an argument. The new test class is - generated in test/integration/testname_test.rb + CamelCased or under_scored, as an argument. + + This generator invokes the current integration tool, which defaults to + TestUnit. Example: `./script/generate integration_test GeneralStories` creates a GeneralStories diff --git a/railties/lib/generators/rails/mailer/USAGE b/railties/lib/generators/rails/mailer/USAGE index 638934d38d..c56095b2c8 100644 --- a/railties/lib/generators/rails/mailer/USAGE +++ b/railties/lib/generators/rails/mailer/USAGE @@ -2,8 +2,8 @@ Description: Stubs out a new mailer and its views. Pass the mailer name, either CamelCased or under_scored, and an optional list of emails as arguments. - This generates a mailer class in app/models, view templates in - app/views/mailer_name and then invokes your test framework. + This generates a mailer class in app/models and invokes your template + engine and test framework generators. Example: `./script/generate mailer Notifications signup forgot_password invoice` diff --git a/railties/lib/generators/rails/observer/USAGE b/railties/lib/generators/rails/observer/USAGE index fca4907ca6..197b5d6e4a 100644 --- a/railties/lib/generators/rails/observer/USAGE +++ b/railties/lib/generators/rails/observer/USAGE @@ -2,8 +2,8 @@ Description: Stubs out a new observer. Pass the observer name, either CamelCased or under_scored, as an argument. - The generator creates an observer class in app/models and a unit test in - the configured test framework. + The generator creates an observer class in app/models and invokes the + configured test framework. Example: `./script/generate observer Account` diff --git a/railties/lib/generators/rails/performance_test/USAGE b/railties/lib/generators/rails/performance_test/USAGE index d84051eb02..ee82578cdb 100644 --- a/railties/lib/generators/rails/performance_test/USAGE +++ b/railties/lib/generators/rails/performance_test/USAGE @@ -1,7 +1,9 @@ Description: Stubs out a new performance test. Pass the name of the test, either - CamelCased or under_scored, as an argument. The new test class is - generated in test/performance/testname_test.rb + CamelCased or under_scored, as an argument. + + This generator invokes the current performance tool, which defaults to + TestUnit. Example: `./script/generate performance_test GeneralStories` creates a GeneralStories |