Rollup merge of #126103 - veera-sivarajan:improve-docs-hir-impl, r=fmease

workingjubilee · web-flow · commit 9436304871dc · 2024-06-06T21:10:11.000-07:00
Improve Docs for `hir::Impl` and `hir::ImplItem` Based on https://rust-lang.zulipchat.com/#narrow/stream/182449-t-compiler.2Fhelp/topic/.E2.9C.94.20Difference.20between.20.60hir.3A.3AImplItem.60.20and.20.60hir.3A.3AImpl.60.3F/near/442650915 r​? fmease
diff --git a/compiler/rustc_hir/src/hir.rs b/compiler/rustc_hir/src/hir.rs
@@ -2345,7 +2345,9 @@ 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 +3329,10 @@ pub enum ItemKind<'hir> {
     Impl(&'hir Impl<'hir>),
 }
 
+/// Represents an impl block declaration.
+///
+/// E.g., `impl $Type { .. }` or `impl $Trait for $Type { .. }`
+/// 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,9 @@ 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`	`+///`
	`2350`	+/// Refer to [`Impl`] for an impl block declaration.
`2349`	`2351`	`#[derive(Debug, Clone, Copy, HashStable_Generic)]`
`2350`	`2352`	`pub struct ImplItem<'hir> {`
`2351`	`2353`	`pub ident: Ident,`
`@@ -3327,6 +3329,10 @@ pub enum ItemKind<'hir> {`
`3327`	`3329`	`Impl(&'hir Impl<'hir>),`
`3328`	`3330`	`}`
`3329`	`3331`
	`3332`	`+/// Represents an impl block declaration.`
	`3333`	`+///`
	`3334`	+/// E.g., `impl $Type { .. }` or `impl $Trait for $Type { .. }`
	`3335`	+/// Refer to [`ImplItem`] for an associated item within an impl block.
`3330`	`3336`	`#[derive(Debug, Clone, Copy, HashStable_Generic)]`
`3331`	`3337`	`pub struct Impl<'hir> {`
`3332`	`3338`	`pub safety: Safety,`