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

Fix autolinks in the documentation #589

Merged
merged 2 commits into from
Jul 7, 2024

Conversation

Jujumba
Copy link
Contributor

@Jujumba Jujumba commented Jul 5, 2024

No description provided.

@Jujumba Jujumba requested a review from asomers as a code owner July 5, 2024 16:03
@@ -1368,7 +1368,7 @@ pub use mockall_derive::concretize;
/// }
/// # fn main() {}
/// ```
/// Mocking an unsupported `#[derive(X)]` attribute, e.g. `Clone`, is
/// Mocking an unsupported `#[derive(X)]` attribute, e.g. [`Clone`], is
Copy link
Owner

Choose a reason for hiding this comment

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

Does this link actually work? Did you generate the docs to check? And is it even worthwhile to make a link here? I don't think many readers will need one.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, the links are valid. I've added them for the sake of consistency

@@ -1388,7 +1388,7 @@ pub use mockall_derive::concretize;
///
/// When mocking a generic struct's implementation of a generic trait, use the
/// same name for their generic parameters. For example, if you wanted to mock
/// `Rc`, do
/// [`Rc`], do
Copy link
Owner

Choose a reason for hiding this comment

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

Likewise, I don't think this needs to be a link. It's not really important for this example that users know exactly what Rc does.

mockall/src/lib.rs Show resolved Hide resolved
Copy link
Owner

@asomers asomers left a comment

Choose a reason for hiding this comment

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

I think you should remove the link to std::rc::Rc; It isn't helpful here.

@Jujumba Jujumba requested a review from asomers July 7, 2024 10:07
@asomers asomers merged commit a0aff68 into asomers:master Jul 7, 2024
3 checks passed
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