aboutsummaryrefslogtreecommitdiffstats
path: root/activesupport/lib/active_support
diff options
context:
space:
mode:
authorclaudiob <claudiob@gmail.com>2014-12-17 16:34:05 -0800
committerclaudiob <claudiob@gmail.com>2014-12-17 16:44:51 -0800
commit23c8f6918d4e6b9a823aa7a91377c6e3b5d60e13 (patch)
treeee02dd33238715269f8e0139d611a88df4d520df /activesupport/lib/active_support
parent78789b7acd566562b58e73a7d4f1a11163370f32 (diff)
downloadrails-23c8f6918d4e6b9a823aa7a91377c6e3b5d60e13.tar.gz
rails-23c8f6918d4e6b9a823aa7a91377c6e3b5d60e13.tar.bz2
rails-23c8f6918d4e6b9a823aa7a91377c6e3b5d60e13.zip
Replace `#=>` with `# =>` [ci skip]
@rafaelfranca suggested in f7c7bcd9 that code examples should display the result after `# =>` and not after `#=>`. This commit replaces *all* the occurrences of `#=>` in the code documentation (mostly added by me :sob:) with the suggested `# =>`.
Diffstat (limited to 'activesupport/lib/active_support')
-rw-r--r--activesupport/lib/active_support/core_ext/hash/deep_merge.rb2
-rw-r--r--activesupport/lib/active_support/core_ext/module/attribute_accessors.rb2
-rw-r--r--activesupport/lib/active_support/core_ext/numeric/bytes.rb14
-rw-r--r--activesupport/lib/active_support/core_ext/object/try.rb4
-rw-r--r--activesupport/lib/active_support/core_ext/thread.rb4
-rw-r--r--activesupport/lib/active_support/core_ext/time/zones.rb16
-rw-r--r--activesupport/lib/active_support/notifications/instrumenter.rb2
7 files changed, 22 insertions, 22 deletions
diff --git a/activesupport/lib/active_support/core_ext/hash/deep_merge.rb b/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
index 763d563231..9c9faf67ea 100644
--- a/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+++ b/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
@@ -4,7 +4,7 @@ class Hash
# h1 = { a: true, b: { c: [1, 2, 3] } }
# h2 = { a: false, b: { x: [3, 4, 5] } }
#
- # h1.deep_merge(h2) #=> { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
+ # h1.deep_merge(h2) # => { a: false, b: { c: [1, 2, 3], x: [3, 4, 5] } }
#
# Like with Hash#merge in the standard library, a block can be provided
# to merge values:
diff --git a/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb b/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
index d317df5079..d4e6b5a1ac 100644
--- a/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
+++ b/activesupport/lib/active_support/core_ext/module/attribute_accessors.rb
@@ -203,7 +203,7 @@ class Module
# include HairColors
# end
#
- # Person.class_variable_get("@@hair_colors") #=> [:brown, :black, :blonde, :red]
+ # Person.class_variable_get("@@hair_colors") # => [:brown, :black, :blonde, :red]
def mattr_accessor(*syms, &blk)
mattr_reader(*syms, &blk)
mattr_writer(*syms, &blk)
diff --git a/activesupport/lib/active_support/core_ext/numeric/bytes.rb b/activesupport/lib/active_support/core_ext/numeric/bytes.rb
index 9996320958..dfbca32474 100644
--- a/activesupport/lib/active_support/core_ext/numeric/bytes.rb
+++ b/activesupport/lib/active_support/core_ext/numeric/bytes.rb
@@ -8,7 +8,7 @@ class Numeric
# Enables the use of byte calculations and declarations, like 45.bytes + 2.6.megabytes
#
- # 2.bytes #=> 2
+ # 2.bytes # => 2
def bytes
self
end
@@ -16,7 +16,7 @@ class Numeric
# Returns the number of bytes equivalent to the kilobytes provided.
#
- # 2.kilobytes #=> 2048
+ # 2.kilobytes # => 2048
def kilobytes
self * KILOBYTE
end
@@ -24,7 +24,7 @@ class Numeric
# Returns the number of bytes equivalent to the megabytes provided.
#
- # 2.megabytes #=> 2_097_152
+ # 2.megabytes # => 2_097_152
def megabytes
self * MEGABYTE
end
@@ -32,7 +32,7 @@ class Numeric
# Returns the number of bytes equivalent to the gigabytes provided.
#
- # 2.gigabytes #=> 2_147_483_648
+ # 2.gigabytes # => 2_147_483_648
def gigabytes
self * GIGABYTE
end
@@ -40,7 +40,7 @@ class Numeric
# Returns the number of bytes equivalent to the terabytes provided.
#
- # 2.terabytes #=> 2_199_023_255_552
+ # 2.terabytes # => 2_199_023_255_552
def terabytes
self * TERABYTE
end
@@ -48,7 +48,7 @@ class Numeric
# Returns the number of bytes equivalent to the petabytes provided.
#
- # 2.petabytes #=> 2_251_799_813_685_248
+ # 2.petabytes # => 2_251_799_813_685_248
def petabytes
self * PETABYTE
end
@@ -56,7 +56,7 @@ class Numeric
# Returns the number of bytes equivalent to the exabytes provided.
#
- # 2.exabytes #=> 2_305_843_009_213_693_952
+ # 2.exabytes # => 2_305_843_009_213_693_952
def exabytes
self * EXABYTE
end
diff --git a/activesupport/lib/active_support/core_ext/object/try.rb b/activesupport/lib/active_support/core_ext/object/try.rb
index 56da398978..26b8d58948 100644
--- a/activesupport/lib/active_support/core_ext/object/try.rb
+++ b/activesupport/lib/active_support/core_ext/object/try.rb
@@ -21,11 +21,11 @@ class Object
#
# +try+ will also return +nil+ if the receiver does not respond to the method:
#
- # @person.try(:non_existing_method) #=> nil
+ # @person.try(:non_existing_method) # => nil
#
# instead of
#
- # @person.non_existing_method if @person.respond_to?(:non_existing_method) #=> nil
+ # @person.non_existing_method if @person.respond_to?(:non_existing_method) # => nil
#
# +try+ returns +nil+ when called on +nil+ regardless of whether it responds
# to the method:
diff --git a/activesupport/lib/active_support/core_ext/thread.rb b/activesupport/lib/active_support/core_ext/thread.rb
index 4cd6634558..9637178f53 100644
--- a/activesupport/lib/active_support/core_ext/thread.rb
+++ b/activesupport/lib/active_support/core_ext/thread.rb
@@ -67,8 +67,8 @@ class Thread
#
# me = Thread.current
# me.freeze
- # me.thread_variable_set(:oliver, "a") #=> RuntimeError: can't modify frozen thread locals
- # me[:oliver] = "a" #=> RuntimeError: can't modify frozen thread locals
+ # me.thread_variable_set(:oliver, "a") # => RuntimeError: can't modify frozen thread locals
+ # me[:oliver] = "a" # => RuntimeError: can't modify frozen thread locals
def freeze
_locals.freeze
super
diff --git a/activesupport/lib/active_support/core_ext/time/zones.rb b/activesupport/lib/active_support/core_ext/time/zones.rb
index 7f295a88ed..0668eadb1e 100644
--- a/activesupport/lib/active_support/core_ext/time/zones.rb
+++ b/activesupport/lib/active_support/core_ext/time/zones.rb
@@ -55,12 +55,12 @@ class Time
# Accepts the time zone in any format supported by <tt>Time.zone=</tt>.
# Raises an ArgumentError for invalid time zones.
#
- # Time.find_zone! "America/New_York" #=> #<ActiveSupport::TimeZone @name="America/New_York" ...>
- # Time.find_zone! "EST" #=> #<ActiveSupport::TimeZone @name="EST" ...>
- # Time.find_zone! -5.hours #=> #<ActiveSupport::TimeZone @name="Bogota" ...>
- # Time.find_zone! nil #=> nil
- # Time.find_zone! false #=> false
- # Time.find_zone! "NOT-A-TIMEZONE" #=> ArgumentError: Invalid Timezone: NOT-A-TIMEZONE
+ # Time.find_zone! "America/New_York" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
+ # Time.find_zone! "EST" # => #<ActiveSupport::TimeZone @name="EST" ...>
+ # Time.find_zone! -5.hours # => #<ActiveSupport::TimeZone @name="Bogota" ...>
+ # Time.find_zone! nil # => nil
+ # Time.find_zone! false # => false
+ # Time.find_zone! "NOT-A-TIMEZONE" # => ArgumentError: Invalid Timezone: NOT-A-TIMEZONE
def find_zone!(time_zone)
if !time_zone || time_zone.is_a?(ActiveSupport::TimeZone)
time_zone
@@ -85,8 +85,8 @@ class Time
# Accepts the time zone in any format supported by <tt>Time.zone=</tt>.
# Returns +nil+ for invalid time zones.
#
- # Time.find_zone "America/New_York" #=> #<ActiveSupport::TimeZone @name="America/New_York" ...>
- # Time.find_zone "NOT-A-TIMEZONE" #=> nil
+ # Time.find_zone "America/New_York" # => #<ActiveSupport::TimeZone @name="America/New_York" ...>
+ # Time.find_zone "NOT-A-TIMEZONE" # => nil
def find_zone(time_zone)
find_zone!(time_zone) rescue nil
end
diff --git a/activesupport/lib/active_support/notifications/instrumenter.rb b/activesupport/lib/active_support/notifications/instrumenter.rb
index 64cb99d2e2..075ddc2382 100644
--- a/activesupport/lib/active_support/notifications/instrumenter.rb
+++ b/activesupport/lib/active_support/notifications/instrumenter.rb
@@ -68,7 +68,7 @@ module ActiveSupport
# sleep 1
# end
#
- # @event.duration #=> 1000.138
+ # @event.duration # => 1000.138
def duration
@duration ||= 1000.0 * (self.end - time)
end