Skip to content

minor: fix external crate links #552

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 13, 2022
Merged

minor: fix external crate links #552

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9f3d2ae
minor: fix external crate links
isabelatkinson Jan 10, 2022
5c32330
use absolute links
isabelatkinson Jan 12, 2022
4076d71
remove absolute for tokio
isabelatkinson Jan 12, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

//! The driver contains a fully async API that supports either [`tokio`](docs.rs/tokio) (default)
//! 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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

//! a sync API that may be enabled via the `"sync"` feature flag.
//!
//! # Installation
Expand Down Expand Up @@ -56,8 +56,8 @@
//! | `async-std-runtime` | Enable support for the `async-std` runtime | `async-std` 1.0 | no |
//! | `sync` | Expose the synchronous API (`mongodb::sync`). This flag cannot be used in conjunction with either of the async runtime feature flags. | `async-std` 1.0 | no |
//! | `aws-auth` | Enable support for the MONGODB-AWS authentication mechanism. | `reqwest` 0.11 | no |
//! | `bson-uuid-0_8` | Enable support for v0.8 of the [`uuid`](docs.rs/uuid/0.8) crate in the public API of the re-exported `bson` crate. | n/a | no |
//! | `bson-chrono-0_4` | Enable support for v0.4 of the [`chrono`](docs.rs/chrono/0.4) crate in the public API of the re-exported `bson` crate. | n/a | no |
//! | `bson-uuid-0_8` | Enable support for v0.8 of the [`uuid`] crate in the public API of the re-exported `bson` crate. | n/a | no |
//! | `bson-chrono-0_4` | Enable support for v0.4 of the [`chrono`] crate in the public API of the re-exported `bson` crate. | n/a | no |
//! | `zlib-compression`] | Enable support for compressing messages with [`zlib`](https://zlib.net/). | `flate2` 1.0 | no |
//! | `zstd-compression` | Enable support for compressing messages with [`zstd`](http://facebook.github.io/zstd/). This flag requires Rust version 1.54. | `zstd` 0.9.0 | no |
//! | `snappy-compression` | Enable support for compressing messages with [`snappy`](http://google.github.io/snappy/). | `snap` 1.0.5 | no |
Expand Down