Skip to content

[DOC] Enhanced RDoc #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
BurdetteLamar merged 4 commits into from
Jul 11, 2022
Merged

[DOC] Enhanced RDoc #62

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
35ec9ae
Enhanced RDoc
BurdetteLamar Jul 10, 2022
ab279a5
Enhanced RDoc
BurdetteLamar Jul 10, 2022
e4b9268
Enhanced RDoc
BurdetteLamar Jul 10, 2022
388502e
Enhanced RDoc
BurdetteLamar Jul 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 57 additions & 33 deletions ext/date/date_core.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5543,7 +5543,7 @@ d_lite_sec(VALUE self)
*
* DateTime.new(2001, 2, 3, 4, 5, 6.5).sec_fraction # => (1/2)
*
* Date.second_fraction is an alias for Date#sec_fraction.
* Date#second_fraction is an alias for Date#sec_fraction.
*/
static VALUE
d_lite_sec_fraction(VALUE self)
Expand Down Expand Up @@ -5584,12 +5584,14 @@ d_lite_zone(VALUE self)

/*
* call-seq:
* d.julian? -> bool
* d.julian? -> true or false
*
* Returns true if the date is before the day of calendar reform.
* Returns +true+ if the date is before the date of calendar reform,
* +false+ otherwise:
*
* (Date.new(1582, 10, 15) - 1).julian? # => true
* Date.new(1582, 10, 15).julian? # => false
*
* Date.new(1582,10,15).julian? #=> false
* (Date.new(1582,10,15) - 1).julian? #=> true
*/
static VALUE
d_lite_julian_p(VALUE self)
Expand All @@ -5600,12 +5602,14 @@ d_lite_julian_p(VALUE self)

/*
* call-seq:
* d.gregorian? -> bool
* gregorian? -> true or false
*
* Returns true if the date is on or after the day of calendar reform.
* Returns +true+ if the date is on or after
* the date of calendar reform, +false+ otherwise:
*
* Date.new(1582, 10, 15).gregorian? # => true
* (Date.new(1582, 10, 15) - 1).gregorian? # => false
*
* Date.new(1582,10,15).gregorian? #=> true
* (Date.new(1582,10,15) - 1).gregorian? #=> false
*/
static VALUE
d_lite_gregorian_p(VALUE self)
Expand All @@ -5616,12 +5620,13 @@ d_lite_gregorian_p(VALUE self)

/*
* call-seq:
* d.leap? -> bool
* leap? -> true or false
*
* Returns +true+ if the year is a leap year, +false+ otherwise:
*
* Returns true if the year is a leap year.
* Date.new(2000).leap? # => true
* Date.new(2001).leap? # => false
*
* Date.new(2000).leap? #=> true
* Date.new(2001).leap? #=> false
*/
static VALUE
d_lite_leap_p(VALUE self)
Expand All @@ -5640,12 +5645,25 @@ d_lite_leap_p(VALUE self)

/*
* call-seq:
* d.start -> float
* start -> float
*
* Returns the Julian start date for calendar reform;
* if not an infinity, the returned value is suitable
* for passing to Date#jd:
*
* d = Date.new(2001, 2, 3, Date::ITALY)
* s = d.start # => 2299161.0
* Date.jd(s).to_s # => "1582-10-15"
*
* d = Date.new(2001, 2, 3, Date::ENGLAND)
* s = d.start # => 2361222.0
* Date.jd(s).to_s # => "1752-09-14"
*
* Returns the Julian day number denoting the day of calendar reform.
* Date.new(2001, 2, 3, Date::GREGORIAN).start # => -Infinity
* Date.new(2001, 2, 3, Date::JULIAN).start # => Infinity
*
* See argument {start}[rdoc-ref:Date@Argument+start].
*
* Date.new(2001,2,3).start #=> 2299161.0
* Date.new(2001,2,3,Date::GREGORIAN).start #=> -Infinity
*/
static VALUE
d_lite_start(VALUE self)
Expand Down Expand Up @@ -5710,12 +5728,17 @@ dup_obj_with_new_start(VALUE obj, double sg)

/*
* call-seq:
* d.new_start([start=Date::ITALY]) -> date
* new_start(start = Date::ITALY]) -> new_date
*
* Returns a copy of +self+ with the given +start+ value:
*
* Duplicates self and resets its day of calendar reform.
* d0 = Date.new(2000, 2, 3)
* d0.julian? # => false
* d1 = d0.new_start(Date::JULIAN)
* d1.julian? # => true
*
* See argument {start}[rdoc-ref:Date@Argument+start].
*
* d = Date.new(1582,10,15)
* d.new_start(Date::JULIAN) #=> #<Date: 1582-10-05 ...>
*/
static VALUE
d_lite_new_start(int argc, VALUE *argv, VALUE self)
Expand All @@ -5734,9 +5757,10 @@ d_lite_new_start(int argc, VALUE *argv, VALUE self)

/*
* call-seq:
* d.italy -> date
* italy -> new_date
*
* Equivalent to Date#new_start with argument Date::ITALY.
*
* This method is equivalent to new_start(Date::ITALY).
*/
static VALUE
d_lite_italy(VALUE self)
Expand All @@ -5746,9 +5770,9 @@ d_lite_italy(VALUE self)

/*
* call-seq:
* d.england -> date
* england -> new_date
*
* This method is equivalent to new_start(Date::ENGLAND).
* Equivalent to Date#new_start with argument Date::ENGLAND.
*/
static VALUE
d_lite_england(VALUE self)
Expand All @@ -5758,9 +5782,9 @@ d_lite_england(VALUE self)

/*
* call-seq:
* d.julian -> date
* julian -> new_date
*
* This method is equivalent to new_start(Date::JULIAN).
* Equivalent to Date#new_start with argument Date::JULIAN.
*/
static VALUE
d_lite_julian(VALUE self)
Expand All @@ -5770,9 +5794,9 @@ d_lite_julian(VALUE self)

/*
* call-seq:
* d.gregorian -> date
* gregorian -> new_date
*
* This method is equivalent to new_start(Date::GREGORIAN).
* Equivalent to Date#new_start with argument Date::GREGORIAN.
*/
static VALUE
d_lite_gregorian(VALUE self)
Expand Down Expand Up @@ -6253,9 +6277,9 @@ d_lite_minus(VALUE self, VALUE other)

/*
* call-seq:
* d.next_day([n=1]) -> date
* next_day(n = 1) -> new_date
*
* This method is equivalent to d + n.
* Equivalent to Date#+ with argument +n+.
*/
static VALUE
d_lite_next_day(int argc, VALUE *argv, VALUE self)
Expand All @@ -6270,9 +6294,9 @@ d_lite_next_day(int argc, VALUE *argv, VALUE self)

/*
* call-seq:
* d.prev_day([n=1]) -> date
* prev_day(n = 1) -> new_date
*
* This method is equivalent to d - n.
* Equivalent to Date#- with argument +n+.
*/
static VALUE
d_lite_prev_day(int argc, VALUE *argv, VALUE self)
Expand Down