Skip to content

Improving introduction in Date/DateTime documentation #110

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

Closed
dkaufman wants to merge 3 commits into from
Closed

Improving introduction in Date/DateTime documentation #110

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d157bb7
Added short introduction and clarified terms
dkaufman Mar 30, 2012
07cb421
Returned slash to top of document block
dkaufman Mar 30, 2012
010213f
Cleaned up introduction documentation
Mar 30, 2012
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
Prev Previous commit
Cleaned up introduction documentation
  • Loading branch information
@dkaufman
Chris Anderson and Daniel Kaufman authored and dkaufman committed Mar 30, 2012
commit 010213f3b079c45ce6b0cee3f835d68b0af9002e
31 changes: 20 additions & 11 deletions ext/date/date_core.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9234,7 +9234,7 @@ Init_date_core(void)
*
* 1998-2011 by Tadayoshi Funaba
*
* Introduction
* = Introduction
*
* Date and DateTime are included in the standard library. To use, require ‘date’ will provide both classes.
*
Expand All @@ -9248,16 +9248,20 @@ Init_date_core(void)
* identified by its ordinal number within a calendar month within
* that year.
*
* In the Date and DateTime classes, this is called "civil".
* Date.civil(2012,03,17) refers to March 17th, 2012
* In the Date and DateTime classes, this is called "civil."
*
* Date.civil(2012,03,17)
* This refers to March 17th, 2012.
*
* === Ordinal date
*
* The ordinal date is a particular day of a calendar year identified
* by its ordinal number within the year.
*
* In the Date and DateTime classes, this is called "ordinal".
* Date.ordinal(2012,77) refers to the 77th day of 2012
* In the Date and DateTime classes, this is called "ordinal."
*
* Date.ordinal(2012,77)
* This refers to the 77th day of 2012.
*
*
* === Week date
Expand All @@ -9270,8 +9274,10 @@ Init_date_core(void)
* includes the first Thursday of that year. In the Gregorian
* calendar, this is equivalent to the week which includes January 4.
*
* In the Date and DateTime classes, this is called "commercial".
* Date.commercial(2012,11,06) refers to the 6th day of the 11th week of 2012
* In the Date and DateTime classes, this is called "commercial."
*
* Date.commercial(2012,11,06)
* This refers to the 6th day of the 11th week of 2012.
*
*
* === Julian day number
Expand All @@ -9288,9 +9294,10 @@ Init_date_core(void)
* it just refers to "chronological Julian day number", not the
* original.
*
* In the Date and DateTime classes, this is called "ajd" and "jd".
* Date.jd(2456004) refers to 2,456,004 days since January 1, 4713 BCE
* Date.new(2012,03,17).ajd #=> (4912007/2)
* In the Date and DateTime classes, this is called "ajd" and "jd."
*
* Date.jd(2456004)
* This refers to 2,456,004 days since January 1, 4713 BCE.
*
* === Modified julian day number
*
Expand All @@ -9308,8 +9315,10 @@ Init_date_core(void)
* appears, it just refers to "chronological modified Julian day
* number", not the original.
*
* In the Date and DateTime classes, this is called "mjd".
* In the Date and DateTime classes, this is called "mjd."
*
* Date.new(2012,03,17).mjd #=> 56003
* 2012-03-17 is 56,003 days after November 17, 1858 CE.
*
* == Date
*
Expand Down