rustdoc: Document that Crate is always local

camelid · camelid · commit 47b0059dba00 · 2021-10-30T11:15:21.000-07:00
diff --git a/src/librustdoc/clean/types.rs b/src/librustdoc/clean/types.rs
@@ -113,6 +113,7 @@ impl From<DefId> for ItemId {
     }
 }
 
+/// The crate currently being documented.
 #[derive(Clone, Debug)]
 crate struct Crate {
     crate name: Symbol,
@@ -142,6 +143,8 @@ crate struct ExternalCrate {
 }
 
 impl ExternalCrate {
+    const LOCAL: Self = Self { crate_num: LOCAL_CRATE };
+
     #[inline]
     crate fn def_id(&self) -> DefId {
         DefId { krate: self.crate_num, index: CRATE_DEF_INDEX }

Original file line number	Diff line number	Diff line change
`@@ -113,6 +113,7 @@ impl From<DefId> for ItemId {`
`113`	`113`	`}`
`114`	`114`	`}`
`115`	`115`
	`116`	`+/// The crate currently being documented.`
`116`	`117`	`#[derive(Clone, Debug)]`
`117`	`118`	`crate struct Crate {`
`118`	`119`	`crate name: Symbol,`
`@@ -142,6 +143,8 @@ crate struct ExternalCrate {`
`142`	`143`	`}`
`143`	`144`
`144`	`145`	`impl ExternalCrate {`
	`146`	`+ const LOCAL: Self = Self { crate_num: LOCAL_CRATE };`
	`147`	`+`
`145`	`148`	`#[inline]`
`146`	`149`	`crate fn def_id(&self) -> DefId {`
`147`	`150`	`DefId { krate: self.crate_num, index: CRATE_DEF_INDEX }`