Project

General

Profile

Actions
Copy link

Bug #5416

closed

Improve documentation for lib/time.rb

Added by jakegoulding (Jake Goulding) over 12 years ago. Updated over 12 years ago.

Status:
Closed
Assignee:
drbrain (Eric Hodel)
Target version:
-
ruby -v:
-
Backport:
[ruby-core:39981]

Description

Documented an undocumented method and constant, as well as restored some useful documentation that was no longer being displayed. Cleaned up some strange wording and added examples to the top of the documentation.

Files

Download all files
0001-Document-zone_offset-and-ZoneOffset.patch (1.76 KB) 0001-Document-zone_offset-and-ZoneOffset.patch jakegoulding (Jake Goulding), 10/06/2011 12:18 PM
0002-Standardize-on-time-zone-vs-timezone.patch (2.25 KB) 0002-Standardize-on-time-zone-vs-timezone.patch jakegoulding (Jake Goulding), 10/06/2011 12:18 PM
0003-Restore-useful-documentation-for-time.rb.patch (2.82 KB) 0003-Restore-useful-documentation-for-time.rb.patch jakegoulding (Jake Goulding), 10/06/2011 12:18 PM
0004-General-cleanup-of-time.rb-documentation.patch (6.96 KB) 0004-General-cleanup-of-time.rb-documentation.patch jakegoulding (Jake Goulding), 10/06/2011 12:18 PM
Actions
Copy link
 #1

Updated by drbrain (Eric Hodel) over 12 years ago

  • Status changed from Open to Closed
  • % Done changed from 0 to 100

This issue was solved with changeset r33418.
Jake, thank you for reporting this issue.
Your contribution to Ruby is greatly appreciated.
May Ruby be with you.

  • lib/time.rb: Clean up Time documentation. Patch by Jake Goulding.
    [Ruby 1.9 - Bug #5416]
Actions
Copy link
 #2 [ruby-core:39983]

Updated by drbrain (Eric Hodel) over 12 years ago

  • ruby -v changed from 1.9.2p290 to -

I merged 1 and 2, merged a small part of 3 (due to #5403) and hand-merged 4 to keep the references to needing to require 'time'.

Historically users have been confused by reading about a method on Time but having it not work. A future version of rdoc may allow this to be removed if it shows the location of these methods.

Actions
Copy link

Also available in: Atom PDF

Like0
Like0Like0