Skip to content

Commit 7e4560b

Browse files
committed
align documentation with conventional practice
and in the process, clear up potential sources of confusion for learners.
1 parent d5c2ff8 commit 7e4560b

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

railties/lib/rails/railtie.rb

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -50,18 +50,18 @@ module Rails
5050
# To add an initialization step to the \Rails boot process from your railtie, just
5151
# define the initialization code with the +initializer+ macro:
5252
#
53-
# class MyRailtie < Rails::Railtie
54-
# initializer "my_railtie.configure_rails_initialization" do
53+
# class MyGem::Railtie < Rails::Railtie
54+
# initializer "my_gem.configure_rails_initialization" do
5555
# # some initialization behavior
5656
# end
5757
# end
5858
#
5959
# If specified, the block can also receive the application object, in case you
6060
# need to access some application-specific configuration, like middleware:
6161
#
62-
# class MyRailtie < Rails::Railtie
63-
# initializer "my_railtie.configure_rails_initialization" do |app|
64-
# app.middleware.use MyRailtie::Middleware
62+
# class MyGem::Railtie < Rails::Railtie
63+
# initializer "my_gem.configure_rails_initialization" do |app|
64+
# app.middleware.use MyGem::Middleware
6565
# end
6666
# end
6767
#
@@ -74,14 +74,14 @@ module Rails
7474
# Railties can access a config object which contains configuration shared by all
7575
# railties and the application:
7676
#
77-
# class MyRailtie < Rails::Railtie
77+
# class MyGem::Railtie < Rails::Railtie
7878
# # Customize the ORM
79-
# config.app_generators.orm :my_railtie_orm
79+
# config.app_generators.orm :my_gem_orm
8080
#
8181
# # Add a to_prepare block which is executed once in production
8282
# # and before each request in development.
8383
# config.to_prepare do
84-
# MyRailtie.setup!
84+
# MyGem.setup!
8585
# end
8686
# end
8787
#
@@ -90,19 +90,19 @@ module Rails
9090
# If your railtie has Rake tasks, you can tell \Rails to load them through the method
9191
# +rake_tasks+:
9292
#
93-
# class MyRailtie < Rails::Railtie
93+
# class MyGem::Railtie < Rails::Railtie
9494
# rake_tasks do
95-
# load "path/to/my_railtie.tasks"
95+
# load "path/to/my_gem.tasks"
9696
# end
9797
# end
9898
#
9999
# By default, \Rails loads generators from your load path. However, if you want to place
100100
# your generators at a different location, you can specify in your railtie a block which
101101
# will load them during normal generators lookup:
102102
#
103-
# class MyRailtie < Rails::Railtie
103+
# class MyGem::Railtie < Rails::Railtie
104104
# generators do
105-
# require "path/to/my_railtie_generator"
105+
# require "path/to/my_gem_generator"
106106
# end
107107
# end
108108
#
@@ -120,7 +120,7 @@ module Rails
120120
# this less confusing for everyone.
121121
# It can be used like this:
122122
#
123-
# class MyRailtie < Rails::Railtie
123+
# class MyGem::Railtie < Rails::Railtie
124124
# server do
125125
# WebpackServer.start
126126
# end

0 commit comments

Comments
 (0)