Tiny documentation edits [ci skip]
* Fix a few typos * Wrap lines to 80 chars * Use `+` instead of `<tt>`
This commit is contained in:
parent
21c74bd769
commit
a8aa8b7fc3
@ -26,7 +26,7 @@ def initialize(root, cache_control)
|
||||
# representing the filename. Otherwise, false is returned.
|
||||
#
|
||||
# Used by the `Static` class to check the existence of a valid file
|
||||
# in the server's `public/` directory. (See Static#call)
|
||||
# in the server's `public/` directory (see Static#call).
|
||||
def match?(path)
|
||||
path = URI.parser.unescape(path)
|
||||
return false unless path.valid_encoding?
|
||||
|
@ -25,17 +25,17 @@ def method_missing(called, *args, &block)
|
||||
end
|
||||
end
|
||||
|
||||
# DeprecatedObjectProxy transforms an object into a deprecated object. It takes an object,
|
||||
# a deprecation message, and optionally a deprecator. The deprecator defaults to
|
||||
# <tt>ActiveSupport::Deprecator</tt> if none is specified.
|
||||
# DeprecatedObjectProxy transforms an object into a deprecated one. It
|
||||
# takes an object, a deprecation message and optionally a deprecator. The
|
||||
# deprecator defaults to +ActiveSupport::Deprecator+ if none is specified.
|
||||
#
|
||||
# deprecated_object = ActiveSupport::Deprecation::DeprecatedObjectProxy.new(Object.new, "This object is now deprecated")
|
||||
# # => <Object:0x007fb9b34c34b0>
|
||||
# # => #<Object:0x007fb9b34c34b0>
|
||||
#
|
||||
# deprecated_object.to_s
|
||||
# DEPRECATION WARNING: This object is now deprecated.
|
||||
# (Backtrace)
|
||||
# # => "<Object:0x007fb9b34c34b0>"
|
||||
# # => "#<Object:0x007fb9b34c34b0>"
|
||||
class DeprecatedObjectProxy < DeprecationProxy
|
||||
def initialize(object, message, deprecator = ActiveSupport::Deprecation.instance)
|
||||
@object = object
|
||||
@ -53,14 +53,15 @@ def warn(callstack, called, args)
|
||||
end
|
||||
end
|
||||
|
||||
# DeprecatedInstanceVariableProxy transforms an instance variable into a deprecated
|
||||
# instance variable. It takes an instance of a class, a method on that class, and an
|
||||
# instance variable. It optionally takes a deprecator as the last argument. The deprecator
|
||||
# defaults to <tt>ActiveSupport::Deprecator</tt> if none is specified.
|
||||
# DeprecatedInstanceVariableProxy transforms an instance variable into a
|
||||
# deprecated one. It takes an instance of a class, a method on that class
|
||||
# and an instance variable. It optionally takes a deprecator as the last
|
||||
# argument. The deprecator defaults to +ActiveSupport::Deprecator+ if none
|
||||
# is specified.
|
||||
#
|
||||
# class Example
|
||||
# def initialize
|
||||
# @request = ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :request, :@request, deprecator)
|
||||
# @request = ActiveSupport::Deprecation::DeprecatedInstanceVariableProxy.new(self, :request, :@request)
|
||||
# @_request = :special_request
|
||||
# end
|
||||
#
|
||||
@ -102,10 +103,11 @@ def warn(callstack, called, args)
|
||||
end
|
||||
end
|
||||
|
||||
# DeprecatedConstantProxy transforms a constant into a deprecated constant. It takes the names of an old
|
||||
# (deprecated) constant and a new contstant (both in string form), and optionally a deprecator. The
|
||||
# deprecator defaults to <tt>ActiveSupport::Deprecator</tt> if none is specified. The deprecated constant
|
||||
# now returns the return value of the new constant.
|
||||
# DeprecatedConstantProxy transforms a constant into a deprecated one. It
|
||||
# takes the names of an old (deprecated) constant and of a new contstant
|
||||
# (both in string form) and optionally a deprecator. The deprecator defaults
|
||||
# to +ActiveSupport::Deprecator+ if none is specified. The deprecated constant
|
||||
# now returns the value of the new one.
|
||||
#
|
||||
# PLANETS = %w(mercury venus earth mars jupiter saturn uranus neptune pluto)
|
||||
#
|
||||
|
@ -8,8 +8,9 @@ module Rails
|
||||
module Rack
|
||||
# Sets log tags, logs the request, calls the app, and flushes the logs.
|
||||
#
|
||||
# Log tags (+taggers+) can be an Array containing: methods that the <tt>request</tt> object responds to, a Proc
|
||||
# that accepts an instance of the <tt>request</tt> object, or something that responds to <tt>to_s</tt>.
|
||||
# Log tags (+taggers+) can be an Array containing: methods that the +request+
|
||||
# object responds to, objects that respond to +to_s+ or Proc objects that accept
|
||||
# an instance of the +request+ object.
|
||||
class Logger < ActiveSupport::LogSubscriber
|
||||
def initialize(app, taggers = nil)
|
||||
@app = app
|
||||
|
Loading…
Reference in New Issue
Block a user