Issue #5402 has been updated by Eric Hodel.

Target version set to 1.9.4

Since the comment from time.c and time.rb will be combined for ri output the introductory sentence should be reworded.  Something like:

  When 'time' is required, Time is extended with additional methods for parsing and converting Times

Unqualified method names should be prefixed with # instead of surrounded by ++, qualified names don't need ++ either and classes should not be surrounded with ++.  This allows rdoc to link methods and classes to their specific documentation:

  # The easiest way to create a new time object is to use either #parse
  # #strptime.  Each uses Date.__parse and Date.__strptime to create a new instance of Time.

For Time.parse, I think an unambiguous date like 2010-10-31 should be used so the month and day position are easy to determine.

The strptime format explanation should be moved to Time.strptime and the list should use :: instead of - as the separator.
----------------------------------------
Bug #5402: Enhancing documentation for Time extension in stlib
http://redmine.ruby-lang.org/issues/5402

Author: Shane Emmons
Status: Open
Priority: Normal
Assignee: Eric Hodel
Category: DOC
Target version: 1.9.4
ruby -v: trunk


As part of Mendicant Universities MRI Documentation Week, I've enhanced the documentation for the Time extension module in stdlib.


-- 
http://redmine.ruby-lang.org