minor: fix external crate links #552
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
isabelatkinson
force-pushed
the
fix-docs-link
branch
from
620dbd3 to
9f3d2ae
Compare
isabelatkinson
commented
Jan 12, 2022
| @@ -1,8 +1,8 @@ | |||
| //! This crate contains the officially supported MongoDB Rust driver, a | |||
| //! client side library that can be used to interact with MongoDB deployments | |||
| //! in Rust applications. It uses the [`bson`](docs.rs/bson) crate for BSON support. | |||
There was a problem hiding this comment.
Links aren't required for external crates specified in this format. docs.rs/bson was being treated as a relative link (i.e. https://docs.rs/mongodb/latest/mongodb/docs.rs/bson); omitting it fixes the issue and properly links to the bson crate.
| //! or [`async-std`](docs.rs/async-std), depending on the feature flags set. The driver also has | ||
| //! in Rust applications. It uses the [`bson`] crate for BSON support. | ||
| //! The driver contains a fully async API that supports either [`tokio`] (default) | ||
| //! or [`async-std`](https://docs.rs/async_std), depending on the feature flags set. The driver also has |
There was a problem hiding this comment.
Using an absolute link here because async-std is an optional dependency, which causes docs tests to fail when the async-std feature is not enabled.
abr-egn
approved these changes
Jan 12, 2022
patrickfreed
approved these changes
Jan 13, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fixes the links to external crates on our docs.rs page that are currently broken.