Skip to content

Commit c28e4f2

Browse files
committed
Use double quotes more consistenly in doc and error messages
For better or worse, the Rails guide settled on double quotes and a large part of the community also use rubocop which enforce them by default. So we might as well try to follow that style when providing code snippets in the documentation or error messages. Fix: rails#49822 I certainly didn't get them all, but consistency should be significantly improved.
1 parent 81ee405 commit c28e4f2

File tree

22 files changed

+84
-84
lines changed

22 files changed

+84
-84
lines changed

actionpack/lib/action_controller/template_assertions.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ module ActionController
44
module TemplateAssertions # :nodoc:
55
def assert_template(options = {}, message = nil)
66
raise NoMethodError,
7-
"assert_template has been extracted to a gem. To continue using it,
8-
add `gem 'rails-controller-testing'` to your Gemfile."
7+
'assert_template has been extracted to a gem. To continue using it,
8+
add `gem "rails-controller-testing"` to your Gemfile.'
99
end
1010
end
1111
end

actionpack/lib/action_dispatch/middleware/templates/rescues/_source.html.erb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
</table>
3030
</div>
3131
<%- unless self.error_highlight_available? -%>
32-
<p class="error_highlight_tip">Tip: You may want to add <code>gem 'error_highlight', '&gt;= 0.4.0'</code> into your Gemfile, which will display the fine-grained error location.</p>
32+
<p class="error_highlight_tip">Tip: You may want to add <code>gem "error_highlight", "&gt;= 0.4.0"</code> into your Gemfile, which will display the fine-grained error location.</p>
3333
<%- end -%>
3434
</div>
3535
<% end %>

actionpack/lib/action_dispatch/testing/test_process.rb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ def file_fixture_upload(path, mime_type = nil, binary = false)
3030

3131
def assigns(key = nil)
3232
raise NoMethodError,
33-
"assigns has been extracted to a gem. To continue using it,
34-
add `gem 'rails-controller-testing'` to your Gemfile."
33+
'assigns has been extracted to a gem. To continue using it,
34+
add `gem "rails-controller-testing"` to your Gemfile.'
3535
end
3636

3737
def session

activemodel/lib/active_model/secure_password.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ module ClassMethods
4141
#
4242
# To use +has_secure_password+, add bcrypt (~> 3.1.7) to your Gemfile:
4343
#
44-
# gem 'bcrypt', '~> 3.1.7'
44+
# gem "bcrypt", "~> 3.1.7"
4545
#
4646
# ==== Examples
4747
#

activestorage/lib/active_storage/transformers/image_processing_transformer.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
rescue LoadError
66
raise LoadError, <<~ERROR.squish
77
Generating image variants require the image_processing gem.
8-
Please add `gem 'image_processing', '~> 1.2'` to your Gemfile.
8+
Please add `gem "image_processing", "~> 1.2"` to your Gemfile.
99
ERROR
1010
end
1111

activesupport/lib/active_support/railtie.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class Railtie < Rails::Railtie # :nodoc:
8989
begin
9090
TZInfo::DataSource.get
9191
rescue TZInfo::DataSourceNotFound => e
92-
raise e.exception "tzinfo-data is not present. Please add gem 'tzinfo-data' to your Gemfile and run bundle install"
92+
raise e.exception('tzinfo-data is not present. Please add gem "tzinfo-data" to your Gemfile and run bundle install')
9393
end
9494
require "active_support/core_ext/time/zones"
9595
Time.zone_default = Time.find_zone!(app.config.time_zone)

activesupport/lib/active_support/xml_mini.rb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ module ActiveSupport
1212
# = \XmlMini
1313
#
1414
# To use the much faster libxml parser:
15-
# gem 'libxml-ruby'
15+
# gem "libxml-ruby"
1616
# XmlMini.backend = 'LibXML'
1717
module XmlMini
1818
extend self

guides/source/3_1_release_notes.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,18 +37,18 @@ The following changes are meant for upgrading your application to Rails 3.1.3, t
3737
Make the following changes to your `Gemfile`.
3838

3939
```ruby
40-
gem 'rails', '= 3.1.3'
41-
gem 'mysql2'
40+
gem "rails", "= 3.1.3"
41+
gem "mysql2"
4242

4343
# Needed for the new asset pipeline
4444
group :assets do
45-
gem 'sass-rails', "~> 3.1.5"
46-
gem 'coffee-rails', "~> 3.1.1"
47-
gem 'uglifier', ">= 1.0.3"
45+
gem "sass-rails", "~> 3.1.5"
46+
gem "coffee-rails", "~> 3.1.1"
47+
gem "uglifier", ">= 1.0.3"
4848
end
4949

5050
# jQuery is the default JavaScript library in Rails 3.1
51-
gem 'jquery-rails'
51+
gem "jquery-rails"
5252
```
5353

5454
#### config/application.rb

guides/source/4_2_release_notes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -179,7 +179,7 @@ change your code to use the explicit form (`render file: "foo/bar"`) instead.
179179

180180
`respond_with` and the corresponding class-level `respond_to` have been moved
181181
to the [responders](https://github.com/plataformatec/responders) gem. Add
182-
`gem 'responders', '~> 2.0'` to your `Gemfile` to use it:
182+
`gem "responders", "~> 2.0"` to your `Gemfile` to use it:
183183

184184
```ruby
185185
# app/controllers/users_controller.rb
@@ -445,7 +445,7 @@ Please refer to the [Changelog][action-pack] for detailed changes.
445445
### Removals
446446
447447
* `respond_with` and the class-level `respond_to` have been removed from Rails and
448-
moved to the `responders` gem (version 2.0). Add `gem 'responders', '~> 2.0'`
448+
moved to the `responders` gem (version 2.0). Add `gem "responders", "~> 2.0"`
449449
to your `Gemfile` to continue using these features.
450450
([Pull Request](https://github.com/rails/rails/pull/16526),
451451
[More Details](https://guides.rubyonrails.org/v4.2/upgrading_ruby_on_rails.html#responders))

guides/source/action_view_overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -152,7 +152,7 @@ It's similar to Builder but is used to generate JSON, instead of XML.
152152
If you don't have it, you can add the following to your `Gemfile`:
153153

154154
```ruby
155-
gem 'jbuilder'
155+
gem "jbuilder"
156156
```
157157

158158
A Jbuilder object named `json` is automatically made available to templates with

0 commit comments

Comments
 (0)