Skip to content

RUST-782 Add hyperlinks for all types in rustdoc #389

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

Merged
merged 3 commits into from
Jan 4, 2023

Conversation

abr-egn
Copy link
Contributor

@abr-egn abr-egn commented Dec 16, 2022

No description provided.

@abr-egn abr-egn requested review from a team and kmahar and removed request for a team December 16, 2022 15:45
Copy link

@kmahar kmahar left a comment

Choose a reason for hiding this comment

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

one suggestion but LGTM otherwise, will tag in the others

//! instead of the `uuid` crate's `Uuid`, since [`crate::Uuid`] correctly produces subtype 4 binary
//! values via either serialization function.
//! instead of the `uuid` crate's [`Uuid`], since [`crate::Uuid`] correctly produces subtype 4
//! binary values via either serialization function.
Copy link

Choose a reason for hiding this comment

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

here and elsewhere in these docs is it worth linking to the corresponding BinarySubtype cases rather than just mentioning subtypes numbers, e.g. BinarySubtype::Generic and BinarySubtype::Uuid?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree that's a reasonable idea, it looks like there's a bunch of places that could use that update so I filed RUST-1561 for that.

@abr-egn abr-egn merged commit 739b84b into mongodb:main Jan 4, 2023
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.

4 participants