Add note on panic behavior

camelid · Mark-Simulacrum · commit 0a3048d95f42 · 2021-01-20T08:01:38.000-05:00
diff --git a/src/librustdoc/clean/utils.rs b/src/librustdoc/clean/utils.rs
@@ -626,6 +626,8 @@ where
 }
 
 /// Find the nearest parent module of a [`DefId`].
+///
+/// **Panics if the item it belongs to [is fake][Item::is_fake].**
 crate fn find_nearest_parent_module(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
     if def_id.is_top_level_module() {
         // The crate root has no parent. Use it as the root instead.

Original file line number	Diff line number	Diff line change
`@@ -626,6 +626,8 @@ where`
`626`	`626`	`}`
`627`	`627`
`628`	`628`	/// Find the nearest parent module of a [`DefId`].
	`629`	`+///`
	`630`	`+/// Panics if the item it belongs to [is fake][Item::is_fake].`
`629`	`631`	`crate fn find_nearest_parent_module(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {`
`630`	`632`	`if def_id.is_top_level_module() {`
`631`	`633`	`// The crate root has no parent. Use it as the root instead.`