Thanks to visit codestin.com
Credit goes to github.com

Skip to content

[DOC] Enhanced RDoc for <=> #65

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
merged 5 commits into from
Jul 28, 2022
Merged

[DOC] Enhanced RDoc for <=> #65

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
6d43cf9
Enhanced RDoc for <=>
BurdetteLamar Jul 27, 2022
93012fa
Enhanced RDoc of <=>
BurdetteLamar Jul 28, 2022
64851ee
Enhanced RDoc for <=>
BurdetteLamar Jul 28, 2022
2b6d1b0
Enhanced RDoc for <=>
BurdetteLamar Jul 28, 2022
ab22093
Update ext/date/date_core.c
BurdetteLamar Jul 28, 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
44 changes: 34 additions & 10 deletions ext/date/date_core.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6708,19 +6708,43 @@ cmp_dd(VALUE self, VALUE other)

/*
* call-seq:
* d <=> other -> -1, 0, +1 or nil
* self <=> other -> -1, 0, 1 or nil
*
* Compares the two dates and returns -1, zero, 1 or nil. The other
* should be a date object or a numeric value as an astronomical
* Julian day number.
* Compares +self+ and +other+, returning:
*
* Date.new(2001,2,3) <=> Date.new(2001,2,4) #=> -1
* Date.new(2001,2,3) <=> Date.new(2001,2,3) #=> 0
* Date.new(2001,2,3) <=> Date.new(2001,2,2) #=> 1
* Date.new(2001,2,3) <=> Object.new #=> nil
* Date.new(2001,2,3) <=> Rational(4903887,2) #=> 0
* - <tt>-1</tt> if +other+ is larger.
* - <tt>0</tt> if the two are equal.
* - <tt>1</tt> if +other+ is smaller.
* - +nil+ if the two are incomparable.
*
* Argument +other+ may be:
*
* - Another \Date object:
*
* d = Date.today # => #<Date: 2022-07-27 ((2459788j,0s,0n),+0s,2299161j)>
* prev_date = d.prev_day # => #<Date: 2022-07-26 ((2459787j,0s,0n),+0s,2299161j)>
* next_date = d.next_day # => #<Date: 2022-07-28 ((2459789j,0s,0n),+0s,2299161j)>
* d <=> next_date # => -1
* d <=> d # => 0
* d <=> prev_date # => 1
*
*
* - A DateTime object:
*
* d <=> DateTime.new(2022, 7, 28) # => -1
* d <=> DateTime.new(2022, 7, 27) # => 0
* d <=> DateTime.new(2022, 7, 29) # => -1
*
* - A numeric (compares <tt>self.jd</tt> to +other+):
*
* d <=> 2459789 # => -1
* d <=> 2459788 # => -1
* d <=> 2459787 # => 1
*
* - Any other object:
*
* d <=> Object.new # => nil
*
* See also Comparable.
*/
static VALUE
d_lite_cmp(VALUE self, VALUE other)
Expand Down