-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
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.
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
Fixing 2 broken links in Dates documentation #21511
Conversation
Searching for information about Dates and DateTime in https://docs.julialang.org/en/release-0.5/manual/dates/ I found broken links at the end of the page, pointing to https://docs.julialang.org/en/latest/stdlib/dates/ Pointing to the stable version makes it work: https://docs.julialang.org/en/stable/stdlib/dates/
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You are changing the master doc, which shouldn't point to the 0.5 version. It also seems that these should probably use reference syntax and not hardcode the full url? Do we support that here?.
OK, should I close this PR and do it on the 0.5 branch? The link https://docs.julialang.org/en/stable/stdlib/dates/ works, whereas https://docs.julialang.org/en/stable/stdlib/dates.html does not. I don't know really much more about the use of reference syntax vs url, so maybe I can open an issue instead of a PR if somebody more skilled wants to solve it? |
This should ideally be fixed using the correct syntax. Hard coding a release-0.5 URL on the 0.5 branch might be good enough for now. The master version should still be properly fixed. |
@@ -559,7 +559,7 @@ julia> round(DateTime(2016, 8, 6, 20, 15), Dates.Day) | |||
Unlike the numeric [`round()`](@ref) method, which breaks ties toward the even number by default, | |||
the [`TimeType`](@ref)[`round()`](@ref) method uses the `RoundNearestTiesUp` rounding mode. (It's | |||
difficult to guess what breaking ties to nearest "even" [`TimeType`](@ref) would entail.) Further | |||
details on the available `RoundingMode` s can be found in the [API reference](https://docs.julialang.org/en/latest/stdlib/dates.html). | |||
details on the available `RoundingMode` s can be found in the [API reference](https://docs.julialang.org/en/stable/stdlib/dates/). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If I'm not mistaken, I think this can be [API reference](@ref Dates)
, which will tell Documenter to link to the Dates section.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That applies to master though; the 0.5 series doesn't use Documenter for docs.
Searching for information about Dates and DateTime in
https://docs.julialang.org/en/release-0.5/manual/dates/
I found broken links at the end of the page, pointing to
https://docs.julialang.org/en/latest/stdlib/dates/
As it is in the doc of the stable 0.5 version, pointing to the stable version of stdlib/dates makes it work:
https://docs.julialang.org/en/stable/stdlib/dates/