Skip to content

Commit ff9b624

Browse files
Prepend $ to example CLI commands [ci-skip]
This allows the syntax highlighter to recognize the code as CLI commands.
1 parent 5cc2f8a commit ff9b624

File tree

6 files changed

+11
-10
lines changed

6 files changed

+11
-10
lines changed

actionmailbox/app/controllers/action_mailbox/ingresses/relay/inbound_emails_controller.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ module ActionMailbox
4141
# If your application lives at <tt>https://example.com</tt>, you would configure the Postfix SMTP server to pipe
4242
# inbound emails to the following command:
4343
#
44-
# bin/rails action_mailbox:ingress:postfix URL=https://example.com/rails/action_mailbox/postfix/inbound_emails INGRESS_PASSWORD=...
44+
# $ bin/rails action_mailbox:ingress:postfix URL=https://example.com/rails/action_mailbox/postfix/inbound_emails INGRESS_PASSWORD=...
4545
#
4646
# Built-in ingress commands are available for these popular SMTP servers:
4747
#

actionpack/lib/action_dispatch/routing.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -238,7 +238,7 @@ module ActionDispatch
238238
#
239239
# == View a list of all your routes
240240
#
241-
# bin/rails routes
241+
# $ bin/rails routes
242242
#
243243
# Target a specific controller with <tt>-c</tt>, or grep routes
244244
# using <tt>-g</tt>. Useful in conjunction with <tt>--expanded</tt>

activerecord/lib/active_record/middleware/database_selector.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ module Middleware
2424
# To use the DatabaseSelector in your application with default settings,
2525
# run the provided generator.
2626
#
27-
# bin/rails g active_record:multi_db
27+
# $ bin/rails g active_record:multi_db
2828
#
2929
# This will create a file named +config/initializers/multi_db.rb+ with the
3030
# following contents:

activerecord/lib/active_record/migration.rb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,8 @@ def initialize
371371
# The \Rails package has several tools to help create and apply migrations.
372372
#
373373
# To generate a new migration, you can use
374-
# bin/rails generate migration MyNewMigration
374+
#
375+
# $ bin/rails generate migration MyNewMigration
375376
#
376377
# where MyNewMigration is the name of your migration. The generator will
377378
# create an empty migration file <tt>timestamp_my_new_migration.rb</tt>
@@ -380,7 +381,7 @@ def initialize
380381
#
381382
# There is a special syntactic shortcut to generate migrations that add fields to a table.
382383
#
383-
# bin/rails generate migration add_fieldname_to_tablename fieldname:string
384+
# $ bin/rails generate migration add_fieldname_to_tablename fieldname:string
384385
#
385386
# This will generate the file <tt>timestamp_add_fieldname_to_tablename.rb</tt>, which will look like this:
386387
# class AddFieldnameToTablename < ActiveRecord::Migration[7.2]

railties/lib/rails/engine.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -328,7 +328,7 @@ module Rails
328328
# To use engine's migrations in application you can use the rake task below, which copies them to
329329
# application's dir:
330330
#
331-
# rake ENGINE_NAME:install:migrations
331+
# $ rake ENGINE_NAME:install:migrations
332332
#
333333
# Note that some of the migrations may be skipped if a migration with the same name already exists
334334
# in application. In such a situation you must decide whether to leave that migration or rename the

railties/lib/rails/generators/base.rb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ def self.hide!
7979
#
8080
# For example, if the user invoke the controller generator as:
8181
#
82-
# bin/rails generate controller Account --test-framework=test_unit
82+
# $ bin/rails generate controller Account --test-framework=test_unit
8383
#
8484
# The controller generator will then try to invoke the following generators:
8585
#
@@ -134,11 +134,11 @@ def self.hide!
134134
# All hooks come with switches for user interface. If you do not want
135135
# to use any test framework, you can do:
136136
#
137-
# bin/rails generate controller Account --skip-test-framework
137+
# $ bin/rails generate controller Account --skip-test-framework
138138
#
139139
# Or similarly:
140140
#
141-
# bin/rails generate controller Account --no-test-framework
141+
# $ bin/rails generate controller Account --no-test-framework
142142
#
143143
# ==== Boolean hooks
144144
#
@@ -150,7 +150,7 @@ def self.hide!
150150
#
151151
# Then, if you want webrat to be invoked, just supply:
152152
#
153-
# bin/rails generate controller Account --webrat
153+
# $ bin/rails generate controller Account --webrat
154154
#
155155
# The hooks lookup is similar as above:
156156
#

0 commit comments

Comments
 (0)