about summary refs log tree commit diff
path: root/compiler/rustc_mir_transform/src/errors.rs
diff options
context:
space:
mode:
authorMatthias Krüger <476013+matthiaskrgr@users.noreply.github.com>2025-06-29 06:59:30 +0200
committerGitHub <noreply@github.com>2025-06-29 06:59:30 +0200
commit6404d29442a238f4876a10e97de73dc2e22d81a7 (patch)
treed6df88385ac2f6dc13a5e1d98d344b3b0b167faa /compiler/rustc_mir_transform/src/errors.rs
parentfd0062cde4d72d0c943b12127cf2b9d4ba58dd03 (diff)
parent1c25bfba9d5bc6e4dfc295e016aac32ff0546f97 (diff)
downloadrust-6404d29442a238f4876a10e97de73dc2e22d81a7.tar.gz
rust-6404d29442a238f4876a10e97de73dc2e22d81a7.zip
Rollup merge of #143088 - firefighterduck:improve-doc-discr-tag, r=RalfJung
Improve documentation of `TagEncoding`

This PR is follow-up from the [discussion here](https://rust-lang.zulipchat.com/#narrow/channel/182449-t-compiler.2Fhelp/topic/.E2.9C.94.20VariantId.3DDiscriminant.20when.20tag.20is.20niche.20encoded.3F/with/524384295).

It aims at making the `TagEncoding` documentation less ambiguous and more detailed with references to relevant implementation sides. It especially clears up the ambiguous use of discriminant/variant index, which sparked the discussion referenced above.

PS: While working with layout data, I somehow ended up looking at the docs for `FakeBorrowKind` and noticed that the one example was not in a doc comment. I hope that this is minor enough of a fix for it to be okay in this otherwise unrelated PR.
Diffstat (limited to 'compiler/rustc_mir_transform/src/errors.rs')
0 files changed, 0 insertions, 0 deletions