Improve Docs for hir::Impl and hir::ImplItem

veera-sivarajan · veera-sivarajan · commit 2185d3faa9b6 · 2024-06-06T17:23:59.000-04:00
diff --git a/compiler/rustc_hir/src/hir.rs b/compiler/rustc_hir/src/hir.rs
@@ -2345,7 +2345,8 @@ impl ImplItemId {
     }
 }
 
-/// Represents anything within an `impl` block.
+/// Represents an associated item within an impl block.
+/// Refer to [`Impl`] for an impl block declaration.
 #[derive(Debug, Clone, Copy, HashStable_Generic)]
 pub struct ImplItem<'hir> {
     pub ident: Ident,
@@ -3327,6 +3328,9 @@ pub enum ItemKind<'hir> {
     Impl(&'hir Impl<'hir>),
 }
 
+/// Represents an impl block declaration.
+/// E.g `impl $Type { .. }` or `impl $Type for $Trait { .. }`
+/// Refer to [`ImplItem`] for an associated item within an impl block.
 #[derive(Debug, Clone, Copy, HashStable_Generic)]
 pub struct Impl<'hir> {
     pub safety: Safety,

Original file line number	Diff line number	Diff line change
`@@ -2345,7 +2345,8 @@ impl ImplItemId {`
`2345`	`2345`	`}`
`2346`	`2346`	`}`
`2347`	`2347`
`2348`		-/// Represents anything within an `impl` block.
	`2348`	`+/// Represents an associated item within an impl block.`
	`2349`	+/// Refer to [`Impl`] for an impl block declaration.
`2349`	`2350`	`#[derive(Debug, Clone, Copy, HashStable_Generic)]`
`2350`	`2351`	`pub struct ImplItem<'hir> {`
`2351`	`2352`	`pub ident: Ident,`
`@@ -3327,6 +3328,9 @@ pub enum ItemKind<'hir> {`
`3327`	`3328`	`Impl(&'hir Impl<'hir>),`
`3328`	`3329`	`}`
`3329`	`3330`
	`3331`	`+/// Represents an impl block declaration.`
	`3332`	+/// E.g `impl $Type { .. }` or `impl $Type for $Trait { .. }`
	`3333`	+/// Refer to [`ImplItem`] for an associated item within an impl block.
`3330`	`3334`	`#[derive(Debug, Clone, Copy, HashStable_Generic)]`
`3331`	`3335`	`pub struct Impl<'hir> {`
`3332`	`3336`	`pub safety: Safety,`