aboutsummaryrefslogtreecommitdiffstats
path: root/railties/lib/rails_generator/generators/components/mailer
diff options
context:
space:
mode:
Diffstat (limited to 'railties/lib/rails_generator/generators/components/mailer')
-rw-r--r--railties/lib/rails_generator/generators/components/mailer/USAGE16
1 files changed, 7 insertions, 9 deletions
diff --git a/railties/lib/rails_generator/generators/components/mailer/USAGE b/railties/lib/rails_generator/generators/components/mailer/USAGE
index 8224a25190..61a649ed4d 100644
--- a/railties/lib/rails_generator/generators/components/mailer/USAGE
+++ b/railties/lib/rails_generator/generators/components/mailer/USAGE
@@ -1,18 +1,16 @@
Description:
- The mailer generator creates stubs for a new mailer and its views.
+ 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.
- The generator takes a mailer name and a list of views as arguments.
- The mailer name may be given in CamelCase or under_score.
-
- The generator creates a mailer class in app/models with view templates
- in app/views/mailer_name, and a test suite with fixtures in test/unit.
+ This generates a mailer class in app/models, view templates in
+ app/views/mailer_name, a unit test in test/unit, and fixtures in
+ test/fixtures.
Example:
- ./script/generate mailer Notifications signup forgot_password invoice
+ `./script/generate mailer Notifications signup forgot_password invoice`
- This will create a Notifications mailer class:
+ creates a Notifications mailer class, views, test, and fixtures:
Mailer: app/models/notifications.rb
Views: app/views/notifications/signup.erb [...]
Test: test/unit/test/unit/notifications_test.rb
Fixtures: test/fixtures/notifications/signup [...]
-