Skip to content

[DOC] Fix broken rdoc-ref to the calendar page #113

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 1 commit into from
Dec 15, 2024
Merged

[DOC] Fix broken rdoc-ref to the calendar page #113

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion doc/date/calendars.rdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ See also {a concrete example here}[rdoc-ref:DateTime@When+should+you+use+DateTim
=== Argument +start+

Certain methods in class \Date handle differences in the
{Julian and Gregorian calendars}[rdoc-ref:calendars.rdoc@Julian+and+Gregorian+Calendars]
{Julian and Gregorian calendars}[rdoc-ref:date/calendars.rdoc@Julian+and+Gregorian+Calendars]
by accepting an optional argument +start+, whose value may be:

- Date::ITALY (the default): the created date is Julian
Expand Down
40 changes: 20 additions & 20 deletions ext/date/date_core.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2498,7 +2498,7 @@ date_s__valid_jd_p(int argc, VALUE *argv, VALUE klass)
*
* Date.valid_jd?(2451944) # => true
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.jd.
*/
Expand Down Expand Up @@ -2592,7 +2592,7 @@ date_s__valid_civil_p(int argc, VALUE *argv, VALUE klass)
* Date.valid_date?(2001, 2, 29) # => false
* Date.valid_date?(2001, 2, -1) # => true
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.jd, Date.new.
*/
Expand Down Expand Up @@ -2680,7 +2680,7 @@ date_s__valid_ordinal_p(int argc, VALUE *argv, VALUE klass)
* Date.valid_ordinal?(2001, 34) # => true
* Date.valid_ordinal?(2001, 366) # => false
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.jd, Date.ordinal.
*/
Expand Down Expand Up @@ -2770,7 +2770,7 @@ date_s__valid_commercial_p(int argc, VALUE *argv, VALUE klass)
*
* See Date.commercial.
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.jd, Date.commercial.
*/
Expand Down Expand Up @@ -3350,7 +3350,7 @@ static VALUE d_lite_plus(VALUE, VALUE);
*
* Date.jd(Date::ITALY - 1).julian? # => true
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.new.
*/
Expand Down Expand Up @@ -3415,7 +3415,7 @@ date_s_jd(int argc, VALUE *argv, VALUE klass)
*
* Raises an exception if +yday+ is zero or out of range.
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.jd, Date.new.
*/
Expand Down Expand Up @@ -3492,7 +3492,7 @@ date_s_civil(int argc, VALUE *argv, VALUE klass)
* where +n+ is the number of days in the month;
* when the argument is negative, counts backward from the end of the month.
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.jd.
*/
Expand Down Expand Up @@ -3598,7 +3598,7 @@ date_initialize(int argc, VALUE *argv, VALUE self)
* Date.commercial(2020, 1, 1).to_s # => "2019-12-30"
Date.commercial(2020, 1, 7).to_s # => "2020-01-05"
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* Related: Date.jd, Date.new, Date.ordinal.
*/
Expand Down Expand Up @@ -3783,7 +3783,7 @@ static void set_sg(union DateData *, double);
*
* Date.today.to_s # => "2022-07-06"
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
*/
static VALUE
Expand Down Expand Up @@ -4415,7 +4415,7 @@ date_s__strptime(int argc, VALUE *argv, VALUE klass)
* {Formats for Dates and Times}[https://docs.ruby-lang.org/en/master/strftime_formatting_rdoc.html].
* (Unlike Date.strftime, does not support flags and width.)
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
* See also {strptime(3)}[https://man7.org/linux/man-pages/man3/strptime.3.html].
*
Expand Down Expand Up @@ -4560,7 +4560,7 @@ date_s__parse(int argc, VALUE *argv, VALUE klass)
*
* See:
*
* - Argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* - Argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
* - Argument {limit}[rdoc-ref:Date@Argument+limit].
*
* Related: Date._parse (returns a hash).
Expand Down Expand Up @@ -4639,7 +4639,7 @@ date_s__iso8601(int argc, VALUE *argv, VALUE klass)
*
* See:
*
* - Argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* - Argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
* - Argument {limit}[rdoc-ref:Date@Argument+limit].
*
* Related: Date._iso8601 (returns a hash).
Expand Down Expand Up @@ -4709,7 +4709,7 @@ date_s__rfc3339(int argc, VALUE *argv, VALUE klass)
*
* See:
*
* - Argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* - Argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
* - Argument {limit}[rdoc-ref:Date@Argument+limit].
*
* Related: Date._rfc3339 (returns a hash).
Expand Down Expand Up @@ -4777,7 +4777,7 @@ date_s__xmlschema(int argc, VALUE *argv, VALUE klass)
*
* See:
*
* - Argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* - Argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
* - Argument {limit}[rdoc-ref:Date@Argument+limit].
*
* Related: Date._xmlschema (returns a hash).
Expand Down Expand Up @@ -4847,7 +4847,7 @@ date_s__rfc2822(int argc, VALUE *argv, VALUE klass)
*
* See:
*
* - Argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* - Argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
* - Argument {limit}[rdoc-ref:Date@Argument+limit].
*
* Related: Date._rfc2822 (returns a hash).
Expand Down Expand Up @@ -4915,7 +4915,7 @@ date_s__httpdate(int argc, VALUE *argv, VALUE klass)
*
* See:
*
* - Argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* - Argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
* - Argument {limit}[rdoc-ref:Date@Argument+limit].
*
* Related: Date._httpdate (returns a hash).
Expand Down Expand Up @@ -4987,7 +4987,7 @@ date_s__jisx0301(int argc, VALUE *argv, VALUE klass)
*
* See:
*
* - Argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* - Argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
* - Argument {limit}[rdoc-ref:Date@Argument+limit].
*
* Related: Date._jisx0301 (returns a hash).
Expand Down Expand Up @@ -5745,7 +5745,7 @@ d_lite_leap_p(VALUE self)
* Date.new(2001, 2, 3, Date::GREGORIAN).start # => -Infinity
* Date.new(2001, 2, 3, Date::JULIAN).start # => Infinity
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
*/
static VALUE
Expand Down Expand Up @@ -5820,7 +5820,7 @@ dup_obj_with_new_start(VALUE obj, double sg)
* d1 = d0.new_start(Date::JULIAN)
* d1.julian? # => true
*
* See argument {start}[rdoc-ref:calendars.rdoc@Argument+start].
* See argument {start}[rdoc-ref:date/calendars.rdoc@Argument+start].
*
*/
static VALUE
Expand Down Expand Up @@ -9522,7 +9522,7 @@ Init_date_core(void)
*
* - You need both dates and times; \Date handles only dates.
* - You need only Gregorian dates (and not Julian dates);
* see {Julian and Gregorian Calendars}[rdoc-ref:calendars.rdoc].
* see {Julian and Gregorian Calendars}[rdoc-ref:date/calendars.rdoc].
*
* A \Date object, once created, is immutable, and cannot be modified.
*
Expand Down
Loading