Skip to content

Commit b228be2

Browse files
committed
Edit rustc_middle::ty::TyKind docs
- Add a definition for this enum. - Fix typo and missing punctuation. - Spell out "algebraic data type".
1 parent 2ad5292 commit b228be2

File tree

1 file changed

+5
-3
lines changed
  • compiler/rustc_middle/src/ty

1 file changed

+5
-3
lines changed

compiler/rustc_middle/src/ty/sty.rs

+5-3
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,8 @@ impl BoundRegionKind {
8888
}
8989
}
9090

91+
/// Defines the kinds of types.
92+
///
9193
/// N.B., if you change this, you'll probably want to change the corresponding
9294
/// AST structure in `librustc_ast/ast.rs` as well.
9395
#[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable, Debug)]
@@ -110,7 +112,7 @@ pub enum TyKind<'tcx> {
110112
/// A primitive floating-point type. For example, `f64`.
111113
Float(ast::FloatTy),
112114

113-
/// Structures, enumerations and unions.
115+
/// Algebraic data types (ADT). For example: structures, enumerations and unions.
114116
///
115117
/// InternalSubsts here, possibly against intuition, *may* contain `Param`s.
116118
/// That is, even after substitution it is possible that there are type
@@ -170,11 +172,11 @@ pub enum TyKind<'tcx> {
170172
/// `|a| yield a`.
171173
Generator(DefId, SubstsRef<'tcx>, hir::Movability),
172174

173-
/// A type representin the types stored inside a generator.
175+
/// A type representing the types stored inside a generator.
174176
/// This should only appear in GeneratorInteriors.
175177
GeneratorWitness(Binder<&'tcx List<Ty<'tcx>>>),
176178

177-
/// The never type `!`
179+
/// The never type `!`.
178180
Never,
179181

180182
/// A tuple type. For example, `(i32, bool)`.

0 commit comments

Comments
 (0)