Skip to content
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

Add more cross-links throughout documentation #290

Merged
merged 2 commits into from
Oct 31, 2020
Merged

Conversation

emlun
Copy link
Contributor

@emlun emlun commented Oct 31, 2020

Hopefully the title says it all. 🙂 I saw that intra-rustdoc links are used in some cases but not all, so I "upgraded" all the ones I could find where it seems appropriate. I did not add links to references to the containing type, for example in "Attempt to create a Date from the year, month, and day." on Date::from_ymd, since that seems a bit redundant. I also did not rewrap any lines as I'm not sure about the convention on that here, but I'd be happy to do so if desired.

@jhpratt
Copy link
Member

jhpratt commented Oct 31, 2020

I'll take a look at this tomorrow, but there's no reason to not do this. With regard to comment wrapping, I generally cap the line length to 80 (including indentation). Unfortunately rustfmt breaks the markdown table in the crate-level documentation, otherwise I'd hand control over to that.

@jhpratt jhpratt self-requested a review October 31, 2020 05:14
@jhpratt jhpratt merged commit a7f3bc5 into time-rs:v0.3 Oct 31, 2020
@emlun emlun deleted the doc-links branch November 1, 2020 04:22
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants