Skip to content

Commit e92ddbf

Browse files
committed
improve hir::map::Map::get_parent_node doc
1 parent 640cfc8 commit e92ddbf

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/librustc/hir/map/mod.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -553,7 +553,9 @@ impl<'hir> Map<'hir> {
553553
}
554554

555555
/// Similar to get_parent, returns the parent node id or id if there is no
556-
/// parent.
556+
/// parent. Note that the parent may be CRATE_NODE_ID, which is not itself
557+
/// present in the map -- so passing the return value of get_parent_node to
558+
/// get may actually panic.
557559
/// This function returns the immediate parent in the AST, whereas get_parent
558560
/// returns the enclosing item. Note that this might not be the actual parent
559561
/// node in the AST - some kinds of nodes are not in the map and these will
@@ -629,7 +631,7 @@ impl<'hir> Map<'hir> {
629631
}
630632

631633
/// Retrieve the NodeId for `id`'s enclosing method, unless there's a
632-
/// `while` or `loop` before reacing it, as block tail returns are not
634+
/// `while` or `loop` before reaching it, as block tail returns are not
633635
/// available in them.
634636
///
635637
/// ```

0 commit comments

Comments
 (0)