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

docs: update docs.rs links to prefer /latest. #306

Merged
merged 1 commit into from
Mar 23, 2023

Conversation

cpu
Copy link
Member

@cpu cpu commented Mar 23, 2023

Previously the Rustls docs linked to docs.rs with URLs containing specific versions of the target crate (e.g.
docs.rs/rustls/0.20.0/...). In this commit all such links are replaced with to use /latest instead of a fixed version.

This provides a simple way to keep things up to date and the risk of future breakage is fairly small since this crate is kept in close synchronicity with the crates it links to.

Resolves #304.

@cpu cpu mentioned this pull request Mar 23, 2023
5 tasks
@jsha
Copy link
Collaborator

jsha commented Mar 23, 2023

Thanks for this! With the recent errors merge, this now has a conflict in src/error.rs.

Previously the Rustls docs linked to docs.rs with URLs containing
specific versions of the target crate (e.g.
`docs.rs/rustls/0.20.0/...`). In this commit all such links are replaced
with to use `/latest` instead of a fixed version.

This provides a simple way to keep things up to date and the risk of
future breakage is fairly small since this crate is kept in close
synchronicity with the crates it links to.
@cpu cpu force-pushed the cpu-304-use-latest-docs branch from cbdf2a7 to db20a81 Compare March 23, 2023 17:37
@cpu
Copy link
Member Author

cpu commented Mar 23, 2023

this now has a conflict in src/error.rs.

All fixed 🧹

Copy link
Collaborator

@jsha jsha left a comment

Choose a reason for hiding this comment

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

📜

@jsha jsha merged commit 51dc47d into rustls:rustls-0.21.0 Mar 23, 2023
@cpu cpu deleted the cpu-304-use-latest-docs branch March 23, 2023 17:45
@cpu cpu mentioned this pull request Mar 23, 2023
jsha pushed a commit that referenced this pull request Mar 29, 2023
Previously the Rustls docs linked to docs.rs with URLs containing
specific versions of the target crate (e.g.
`docs.rs/rustls/0.20.0/...`). In this commit all such links are replaced
with to use `/latest` instead of a fixed version.

This provides a simple way to keep things up to date and the risk of
future breakage is fairly small since this crate is kept in close
synchronicity with the crates it links to.
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