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

Remove relative link when possible and fix invalid links #2423

Conversation

damienrg
Copy link
Contributor

Replaces relative links by rusdoc link resolution when possible to have a compile error when links cannot be resolved.

Fix invalid links to AsyncRead and AsyncWrite in tokio-util.

Fix link to tokio::main in Runtime::new().

The link to tokio::main was relative to tokio_macros crate in the source
directory.
This is why it worked in local build of documentation and not in doc.rs.

Related to tokio-rs#1473.
Use rustdoc automatic link resolution over relative path to have compile
time error when it could not resolve links.

Fix invalid links to AsyncRead and AsyncWrite in tokio-util.

Related to tokio-rs#1473.
@Darksonn Darksonn added C-maintenance Category: PRs that clean code up or issues documenting cleanup. T-docs Topic: documentation A-tokio Area: The main tokio crate A-tokio-util Area: The tokio-util crate S-waiting-on-author Status: awaiting some action (such as code changes) from the PR or issue author. labels Apr 21, 2020
Copy link
Contributor

@Darksonn Darksonn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The links look good!

@Darksonn Darksonn removed the S-waiting-on-author Status: awaiting some action (such as code changes) from the PR or issue author. label Apr 21, 2020
@Darksonn Darksonn merged commit 43bbbf6 into tokio-rs:master Apr 21, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio Area: The main tokio crate A-tokio-util Area: The tokio-util crate C-maintenance Category: PRs that clean code up or issues documenting cleanup. T-docs Topic: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants