Skip to content

[DOC] Fix markups as Markdown #79

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
nobu merged 1 commit into from
Oct 28, 2022
Merged

[DOC] Fix markups as Markdown #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 6 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Date
# `Date`

A subclass of Object that includes the Comparable module and easily handles date.
A subclass of `Object` that includes the `Comparable` module and easily handles date.

## Installation

Expand All @@ -24,7 +24,7 @@ Or install it yourself as:
require 'date'
```

A Date object is created with Date::new, Date::jd, Date::ordinal, Date::commercial, Date::parse, Date::strptime, Date::today, Time#to_date, etc.
A `Date` object is created with `Date::new`, `Date::jd`, `Date::ordinal`, `Date::commercial`, `Date::parse`, `Date::strptime`, `Date::today`, `Time#to_date`, etc.

```ruby
require 'date'
Expand All @@ -45,15 +45,15 @@ Time.new(2001,2,3).to_date
#=> #<Date: 2001-02-03 ...>
```

All date objects are immutable; hence cannot modify themselves.
All `Date` objects are immutable; hence cannot modify themselves.

The concept of a date object can be represented as a tuple of the day count, the offset and the day of calendar reform.

The day count denotes the absolute position of a temporal dimension. The offset is relative adjustment, which determines decoded local time with the day count. The day of calendar reform denotes the start day of the new style. The old style of the West is the Julian calendar which was adopted by Caesar. The new style is the Gregorian calendar, which is the current civil calendar of many countries.

The day count is virtually the astronomical Julian day number. The offset in this class is usually zero, and cannot be specified directly.

A Date object can be created with an optional argument, the day of calendar reform as a Julian day number, which should be 2298874 to 2426355 or negative/positive infinity. The default value is +Date::ITALY+ (2299161=1582-10-15). See also sample/cal.rb.
A `Date` object can be created with an optional argument, the day of calendar reform as a Julian day number, which should be 2298874 to 2426355 or negative/positive infinity. The default value is `Date::ITALY` (2299161=1582-10-15). See also sample/cal.rb.

```
$ ruby sample/cal.rb -c it 10 1582
Expand All @@ -74,7 +74,7 @@ S M Tu W Th F S
24 25 26 27 28 29 30
```

A Date object has various methods. See each reference.
A `Date` object has various methods. See each reference.

```ruby
d = Date.parse('3rd Feb 2001')
Expand Down