aboutsummaryrefslogtreecommitdiffstats
path: root/activestorage/app/models/active_storage/variation.rb
diff options
context:
space:
mode:
authorKoichi ITO <koic.ito@gmail.com>2017-08-11 12:36:07 +0900
committerKoichi ITO <koic.ito@gmail.com>2017-08-11 13:15:23 +0900
commitd90f26156279c2dd53eaabeb8794e8ecd2b3d0fa (patch)
tree56870b6d6dbcd30ca26d03063dcbeb8b947ae267 /activestorage/app/models/active_storage/variation.rb
parentcb3c227c456bcbcd91c4a8fac4ff46f255621514 (diff)
downloadrails-d90f26156279c2dd53eaabeb8794e8ecd2b3d0fa.tar.gz
rails-d90f26156279c2dd53eaabeb8794e8ecd2b3d0fa.tar.bz2
rails-d90f26156279c2dd53eaabeb8794e8ecd2b3d0fa.zip
Fix formatting of Active Storage docs [ci skip]
Follow up of #30188.
Diffstat (limited to 'activestorage/app/models/active_storage/variation.rb')
-rw-r--r--activestorage/app/models/active_storage/variation.rb8
1 files changed, 4 insertions, 4 deletions
diff --git a/activestorage/app/models/active_storage/variation.rb b/activestorage/app/models/active_storage/variation.rb
index e784506b4c..24168c064c 100644
--- a/activestorage/app/models/active_storage/variation.rb
+++ b/activestorage/app/models/active_storage/variation.rb
@@ -13,12 +13,12 @@ class ActiveStorage::Variation
attr_reader :transformations
class << self
- # Returns a variation instance with the transformations that were encoded by `#encode`.
+ # Returns a variation instance with the transformations that were encoded by +#encode+.
def decode(key)
new ActiveStorage.verifier.verify(key, purpose: :variation)
end
- # Returns a signed key for the `transformations`, which can be used to refer to a specific
+ # Returns a signed key for the +transformations+, which can be used to refer to a specific
# variation in a URL or combined key (like `ActiveStorage::Variant#key`).
def encode(transformations)
ActiveStorage.verifier.generate(transformations, purpose: :variation)
@@ -30,7 +30,7 @@ class ActiveStorage::Variation
end
# Accepts an open MiniMagick image instance, like what's return by `MiniMagick::Image.read(io)`,
- # and performs the `transformations` against it. The transformed image instance is then returned.
+ # and performs the +transformations+ against it. The transformed image instance is then returned.
def transform(image)
transformations.each do |(method, argument)|
if eligible_argument?(argument)
@@ -41,7 +41,7 @@ class ActiveStorage::Variation
end
end
- # Returns a signed key for all the `transformations` that this variation was instantiated with.
+ # Returns a signed key for all the +transformations+ that this variation was instantiated with.
def key
self.class.encode(transformations)
end