Fix autolinks in the documentation #589
Merged
Conversation
This file contains 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
asomers
reviewed
Jul 5, 2024
| @@ -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 | |||
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Yes, the links are valid. I've added them for the sake of consistency
mockall/src/lib.rs
Outdated
| @@ -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 | |||
There was a problem hiding this comment.
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.
asomers
requested changes
Jul 6, 2024
asomers
approved these changes
Jul 7, 2024
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.
No description provided.