Skip to content

Commit d4a9712

Browse files
committed
Doc improvements
1 parent 1404a1b commit d4a9712

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

lib/moneta/transform.rb

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ module Moneta
44
# Handles encoding/decoding of arbitrary objects into something that can be stored in a backend. Most transforms
55
# encode to string.
66
#
7-
# @abstract Subclasses should implement {#encode} and {#decode} or use {.delegate_to} to delegate to another object.
8-
# They may also implement {#encoded?} if it is possible to efficiently test the
7+
# @abstract Subclasses should implement {#encode} and {#decode} or use {Moneta::Serializer.delegate_to} to delegate to
8+
# another object. They may also implement {#encoded?} if it is possible to efficiently test whether something was
9+
# encoded (e.g. using a magic number).
910
class Transform
1011
autoload :Serializer, "moneta/transform/serializer"
1112

@@ -30,8 +31,8 @@ class Transform
3031
# delegate_to ::CGI, %[escapeURIComponent unescapeURIComponent]
3132
# end
3233
#
33-
# @param {Module} object The object to delegate to
34-
# @param {[Symbol,Symbol]} methods The methods on +object+ to delegate to
34+
# @param object [Module] The object to delegate to
35+
# @param methods [<Symbol,Symbol>] The methods on +object+ to delegate to
3536
def self.delegate_to(object, methods = nil)
3637
extend Forwardable
3738

0 commit comments

Comments
 (0)