diff options
| author | schneems <richard.schneeman@gmail.com> | 2014-05-09 11:50:35 -0500 |
|---|---|---|
| committer | schneems <richard.schneeman@gmail.com> | 2014-05-09 11:50:35 -0500 |
| commit | 7063e254bf2a24cda7d7f3e07ba50ac1b44a8d2f (patch) | |
| tree | 04b3890e9927bd7e9a5417c5dd1d3ad9669d68d5 /activesupport/lib | |
| parent | aabbf07d003d78a685c0cdcb8e8f9e7fbb02361c (diff) | |
| download | rails-7063e254bf2a24cda7d7f3e07ba50ac1b44a8d2f.tar.gz rails-7063e254bf2a24cda7d7f3e07ba50ac1b44a8d2f.tar.bz2 rails-7063e254bf2a24cda7d7f3e07ba50ac1b44a8d2f.zip | |
[ci skip] doc ActiveSupport::TimeWithZone#to_s
Current docs are wrong. Does not accept strftime inputs.
Diffstat (limited to 'activesupport/lib')
| -rw-r--r-- | activesupport/lib/active_support/time_with_zone.rb | 7 |
1 files changed, 5 insertions, 2 deletions
diff --git a/activesupport/lib/active_support/time_with_zone.rb b/activesupport/lib/active_support/time_with_zone.rb index c25c97cfa8..f2a2f3c3db 100644 --- a/activesupport/lib/active_support/time_with_zone.rb +++ b/activesupport/lib/active_support/time_with_zone.rb @@ -185,8 +185,11 @@ module ActiveSupport end alias_method :rfc822, :rfc2822 - # <tt>:db</tt> format outputs time in UTC; all others output time in local. - # Uses TimeWithZone's +strftime+, so <tt>%Z</tt> and <tt>%z</tt> work correctly. + # Returns a string of the object's date and time. + # Accepts an optional <tt>format</tt>: + # * <tt>:default</tt> - default value, mimics Ruby 1.9 Time#to_s format. + # * <tt>:db</tt> - format outputs time in UTC :db time. See Time#to_formatted_s(:db). + # * Any key in <tt>Time::DATE_FORMATS</tt> can be used. See active_support/core_ext/time/conversions.rb. def to_s(format = :default) if format == :db utc.to_s(format) |