Small improvements to the documentaion of FnAbi #125154
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
|
Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @wesleywiser (or someone else) some time within the next two weeks. Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (
|
rustbot
added
S-waiting-on-review
This comment has been minimized.
This comment has been minimized.
compiler-errors
requested changes
May 15, 2024
|
I have fixed the nits, and squashed the commits. Should be good to merge now. |
compiler-errors
approved these changes
May 15, 2024
|
@bors r+ |
bors
added
S-waiting-on-bors
|
@bors rollup=always |
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 15, 2024
Rollup of 5 pull requests Successful merges: - rust-lang#125003 (avoid using aligned_alloc; posix_memalign is better-behaved) - rust-lang#125142 (Migrate `run-make/rustdoc-themes` to new rmake.rs) - rust-lang#125146 (Migrate `run-make/panic-impl-transitive` to `rmake`) - rust-lang#125154 (Small improvements to the documentaion of FnAbi ) - rust-lang#125159 (Meta: Allow unauthenticated users to modify `L-*`, `PG-*` and `-Z*` labels) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
May 15, 2024
Rollup merge of rust-lang#125154 - FractalFir:fnabi_doc, r=compiler-errors Small improvements to the documentaion of FnAbi I have updated the documentation of `FnAbi`. The `arg` and `ret` fields are no longer LLVM types, but Rust types(`ArgAbi` contains a `TyAndLayout` and a `PassMode`), so I changed the documentation to reflect that. Besides that, I also added documentation to other fields, and added a clarification about the differences between `FnAbi` and `FnSig`, since this is not something that is immediately obvious.
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.
I have updated the documentation of
FnAbi.The
argandretfields are no longer LLVM types, but Rust types(ArgAbicontains aTyAndLayoutand aPassMode), so I changed the documentation to reflect that.Besides that, I also added documentation to other fields, and added a clarification about the differences between
FnAbiandFnSig, since this is not something that is immediately obvious.