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 doc comment on AssetActionMinimal #11105
Fix doc comment on AssetActionMinimal #11105
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the second link can be entirely removed. We don't need to link twice in the same sentence. We can go even one step further and reword the sentence to avoid mentioning the name twice.
This repetition is present on |
Since the scope of this PR is quite small, I think you can re-scope it to remove all the repetitions. It may be reworded to something like: /// Minimal version of [`X`].
///
/// Speeds up or enables serialization where the non-minimal version of the item is not needed. Also keep in mind that when splitting in two sentences, repetition is less of a problem. In any case, there shouldn't be a double link. |
This PR can be closed. The comment has been updated sometime around Asset V2. |
This PR is post-assets-v2 and is about |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is an improvement as-is.
Whoops! My bad 😅 |
rebasing to get new required ci jobs... but forgot that I should have wait a few more minutes 🤦 |
Objective
The doc comment on
AssetActionMinimal
links to itself instead ofAssetAction