aboutsummaryrefslogtreecommitdiffstats
path: root/activerecord
diff options
context:
space:
mode:
authorRyuta Kamizono <kamipo@gmail.com>2018-09-02 19:12:38 +0900
committerGitHub <noreply@github.com>2018-09-02 19:12:38 +0900
commit240319933003edfd5718df6b6ebf5872791df9c0 (patch)
tree876b8bcea660f1051ffde286a4ba69a098611827 /activerecord
parent736559d955c19392f6bba29960de639d49eb1814 (diff)
parent310afd6b43938ef6c0e316326a9eb32ec365d51e (diff)
downloadrails-240319933003edfd5718df6b6ebf5872791df9c0.tar.gz
rails-240319933003edfd5718df6b6ebf5872791df9c0.tar.bz2
rails-240319933003edfd5718df6b6ebf5872791df9c0.zip
Merge pull request #33774 from sharang-d/comment-changes
Change some comments to conform to the style used in other comments [ci skip]
Diffstat (limited to 'activerecord')
-rw-r--r--activerecord/lib/active_record/database_configurations.rb8
-rw-r--r--activerecord/lib/active_record/database_configurations/hash_config.rb2
-rw-r--r--activerecord/lib/active_record/database_configurations/url_config.rb2
3 files changed, 6 insertions, 6 deletions
diff --git a/activerecord/lib/active_record/database_configurations.rb b/activerecord/lib/active_record/database_configurations.rb
index 2ec69e682a..64dd972a47 100644
--- a/activerecord/lib/active_record/database_configurations.rb
+++ b/activerecord/lib/active_record/database_configurations.rb
@@ -26,12 +26,12 @@ module ActiveRecord
#
# <tt>env_name:</tt> The environment name. Defaults to nil which will collect
# configs for all environments.
- # <tt>spec_name:</tt> The specification name (ie primary, animals, etc). Defailts
- # to nil.
+ # <tt>spec_name:</tt> The specification name (ie primary, animals, etc.). Defaults
+ # to +nil+.
# <tt>include_replicas:</tt> Determines whether to include replicas in the
# the returned list. Most of the time we're only iterating over the write
- # connection (ie migrations don't need to run for the write and read connection).
- # Defaults to false.
+ # connection (i.e. migrations don't need to run for the write and read connection).
+ # Defaults to +false+.
def configs_for(env_name: nil, spec_name: nil, include_replicas: false, &blk)
configs = env_with_configs(env_name)
diff --git a/activerecord/lib/active_record/database_configurations/hash_config.rb b/activerecord/lib/active_record/database_configurations/hash_config.rb
index 55b6ef65c4..18ed7c0466 100644
--- a/activerecord/lib/active_record/database_configurations/hash_config.rb
+++ b/activerecord/lib/active_record/database_configurations/hash_config.rb
@@ -34,7 +34,7 @@ module ActiveRecord
# Determines whether a database configuration is for a replica / readonly
# connection. If the `replica` key is present in the config, `replica?` will
- # return true.
+ # return +true+.
def replica?
config["replica"]
end
diff --git a/activerecord/lib/active_record/database_configurations/url_config.rb b/activerecord/lib/active_record/database_configurations/url_config.rb
index ad4df3d3f2..f526c59d56 100644
--- a/activerecord/lib/active_record/database_configurations/url_config.rb
+++ b/activerecord/lib/active_record/database_configurations/url_config.rb
@@ -43,7 +43,7 @@ module ActiveRecord
# Determines whether a database configuration is for a replica / readonly
# connection. If the `replica` key is present in the config, `replica?` will
- # return true.
+ # return +true+.
def replica?
config["replica"]
end