cranelift-frontend: add and fix various links in doc comments
#8548
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
bjorn3
reviewed
May 4, 2024
tertsdiepraam
force-pushed
the
cranelift-frontend-links
branch
from
42d41c3
to
ee6956e
Compare
|
Looks good to me! Thanks for the changes. Can you amend your commit and add the following somewhere in the doc message so we can trigger the doc build? That way we can see if there's any dead link warnings or the like. |
tertsdiepraam
force-pushed
the
cranelift-frontend-links
branch
from
ee6956e
to
d323157
Compare
github-actions
bot
added
the
cranelift
jameysharp
approved these changes
May 12, 2024
There was a problem hiding this comment.
I agree with @abrown, this all looks good, and it passed the prtest:full CI run so let's merge it. Thank you!
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.
While reading through the documentation for
cranelift-frontend, I noticed that there were some things that could be converted into links. There were also some links that were spelled out, such asstruct.FunctionBuilderContext.html, which is unnecessary and confuses rust-analyzer.I've tried to fix up all the easy cases that I could find within this crate. Let me know if you want me to split this up over multiple commits or something like that.