Skip to content

Commit e116732

Browse files
Rollup merge of #80225 - pierwill:patch-11, r=lcnr
Add module-level docs to rustc_middle::ty I thought it would be nice to point out `Ty` and `TyCtxt` on the module page, and link out to the [rustc-dev-guide chapter](https://rustc-dev-guide.rust-lang.org/ty.html).
2 parents f9f8446 + 9f8c8e4 commit e116732

File tree

1 file changed

+11
-0
lines changed
  • compiler/rustc_middle/src/ty

1 file changed

+11
-0
lines changed

compiler/rustc_middle/src/ty/mod.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,14 @@
1+
//! Defines how the compiler represents types internally.
2+
//!
3+
//! Two important entities in this module are:
4+
//!
5+
//! - [`rustc_middle::ty::Ty`], used to represent the semantics of a type.
6+
//! - [`rustc_middle::ty::TyCtxt`], the central data structure in the compiler.
7+
//!
8+
//! For more information, see ["The `ty` module: representing types"] in the ructc-dev-guide.
9+
//!
10+
//! ["The `ty` module: representing types"]: https://rustc-dev-guide.rust-lang.org/ty.html
11+
112
// ignore-tidy-filelength
213
pub use self::fold::{TypeFoldable, TypeFolder, TypeVisitor};
314
pub use self::AssocItemContainer::*;

0 commit comments

Comments
 (0)