1
Fork 0

Rename confusing function name

This commit is contained in:
Michael Goulet 2024-04-11 13:14:08 -04:00
parent d2dabeee76
commit b826eb219c
4 changed files with 9 additions and 9 deletions

View file

@ -511,14 +511,14 @@ impl<'hir> Map<'hir> {
self.body_const_context(self.enclosing_body_owner(hir_id)).is_some()
}
/// Retrieves the `HirId` for `id`'s enclosing method's body, unless there's a
/// `while` or `loop` before reaching it, as block tail returns are not
/// available in them.
/// Retrieves the `HirId` for `id`'s enclosing function *if* the `id` block or return is
/// in the "tail" position of the function, in other words if it's likely to correspond
/// to the return type of the function.
///
/// ```
/// fn foo(x: usize) -> bool {
/// if x == 1 {
/// true // If `get_return_block` gets passed the `id` corresponding
/// true // If `get_fn_id_for_return_block` gets passed the `id` corresponding
/// } else { // to this, it will return `foo`'s `HirId`.
/// false
/// }
@ -528,12 +528,12 @@ impl<'hir> Map<'hir> {
/// ```compile_fail,E0308
/// fn foo(x: usize) -> bool {
/// loop {
/// true // If `get_return_block` gets passed the `id` corresponding
/// true // If `get_fn_id_for_return_block` gets passed the `id` corresponding
/// } // to this, it will return `None`.
/// false
/// }
/// ```
pub fn get_return_block(self, id: HirId) -> Option<HirId> {
pub fn get_fn_id_for_return_block(self, id: HirId) -> Option<HirId> {
let mut iter = self.parent_iter(id).peekable();
let mut ignore_tail = false;
if let Node::Expr(Expr { kind: ExprKind::Ret(_), .. }) = self.tcx.hir_node(id) {