Skip to content

Commit

Permalink
Enhanced RDoc (#67)
Browse files Browse the repository at this point in the history
Treats:
    ::httpdate
    #to_date
    #to_time
    #to_datetime
In behalf of ::httpdate, I've introduced section "Argument limit" that can be pointed to by various Date methods (similar to existing section "Argument start"). This will involve 8 already-enhanced methods plus 8 more not yet done.
  • Loading branch information
BurdetteLamar committed Jul 30, 2022
1 parent aed66fe commit 00326ff
Showing 1 changed file with 34 additions and 10 deletions.
44 changes: 34 additions & 10 deletions ext/date/date_core.c
Expand Up @@ -4833,11 +4833,14 @@ date_s_rfc2822(int argc, VALUE *argv, VALUE klass)
* call-seq:
* Date._httpdate(string, limit: 128) -> hash
*
* Returns a hash of parsed elements.
* Returns a hash of values parsed from +string+:
*
* Raise an ArgumentError when the string length is longer than _limit_.
* You can stop this check by passing <code>limit: nil</code>, but note
* that it may take a long time to parse.
* d = Date.new(2001, 2, 3)
* s = d.httpdate # => "Sat, 03 Feb 2001 00:00:00 GMT"
* Date._httpdate(s)
* # => {:wday=>6, :mday=>3, :mon=>2, :year=>2001, :hour=>0, :min=>0, :sec=>0, :zone=>"GMT", :offset=>0}
*
* See argument {limit}[rdoc-ref:Date@Argument+limit].
*/
static VALUE
date_s__httpdate(int argc, VALUE *argv, VALUE klass)
Expand Down Expand Up @@ -8760,10 +8763,15 @@ time_to_datetime(VALUE self)

/*
* call-seq:
* d.to_time -> time
* to_time -> time
*
* Returns a new Time object with the same value as +self+;
* if +self+ is a Julian date, derives its Gregorian date
* for conversion to the \Time object:
*
* Date.new(2001, 2, 3).to_time # => 2001-02-03 00:00:00 -0600
* Date.new(2001, 2, 3, Date::JULIAN).to_time # => 2001-02-16 00:00:00 -0600
*
* Returns a Time object which denotes self. If self is a julian date,
* convert it to a gregorian date before converting it to Time.
*/
static VALUE
date_to_time(VALUE self)
Expand All @@ -8784,9 +8792,9 @@ date_to_time(VALUE self)

/*
* call-seq:
* d.to_date -> self
* to_date -> self
*
* Returns self.
* Returns +self+.
*/
static VALUE
date_to_date(VALUE self)
Expand All @@ -8798,7 +8806,10 @@ date_to_date(VALUE self)
* call-seq:
* d.to_datetime -> datetime
*
* Returns a DateTime object which denotes self.
* Returns a DateTime whose value is the same as +self+:
*
* Date.new(2001, 2, 3).to_datetime # => #<DateTime: 2001-02-03T00:00:00+00:00>
*
*/
static VALUE
date_to_datetime(VALUE self)
Expand Down Expand Up @@ -9498,6 +9509,19 @@ Init_date_core(void)
* - Date::JULIAN - no changeover date; all dates are Julian.
* - Date::GREGORIAN - no changeover date; all dates are Gregorian.
*
* === Argument +limit+
*
* Certain singleton methods in \Date that parse string arguments
* also take optional keyword argument +limit+,
* which can limit the length of the string argument.
*
* When +limit+ is:
*
* - Non-negative:
* raises ArgumentError if the string length is greater than _limit_.
* - Other numeric or +nil+: ignores +limit+.
* - Other non-numeric: raises TypeError.
*
*/
cDate = rb_define_class("Date", rb_cObject);

Expand Down

0 comments on commit 00326ff

Please sign in to comment.