From b43a3948a1722f08db4d1633e3572e0d7c988d7d Mon Sep 17 00:00:00 2001 From: overlookmotel <557937+overlookmotel@users.noreply.github.com> Date: Wed, 28 Aug 2024 10:10:04 +0000 Subject: [PATCH] refactor(traverse): correct code comments (#5293) #5286 changed `TraverseCtx::ancestor` to always return an `Ancestor`. Update doc comments to reflect that. --- crates/oxc_traverse/src/context/ancestry.rs | 2 +- crates/oxc_traverse/src/context/mod.rs | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/crates/oxc_traverse/src/context/ancestry.rs b/crates/oxc_traverse/src/context/ancestry.rs index 67790532dfc6c..6793df6248b91 100644 --- a/crates/oxc_traverse/src/context/ancestry.rs +++ b/crates/oxc_traverse/src/context/ancestry.rs @@ -58,7 +58,7 @@ impl<'a> TraverseAncestry<'a> { /// Get ancestor of current node. /// /// `level` is number of levels above. - /// `ancestor(1).unwrap()` is equivalent to `parent()`. + /// `ancestor(1)` is equivalent to `parent()`. /// /// If `level` is out of bounds (above `Program`), returns `Ancestor::None`. #[inline] diff --git a/crates/oxc_traverse/src/context/mod.rs b/crates/oxc_traverse/src/context/mod.rs index 6922d75e5d473..7b1665218eaeb 100644 --- a/crates/oxc_traverse/src/context/mod.rs +++ b/crates/oxc_traverse/src/context/mod.rs @@ -141,7 +141,7 @@ impl<'a> TraverseCtx<'a> { /// Get ancestor of current node. /// /// `level` is number of levels above. - /// `ancestor(1).unwrap()` is equivalent to `parent()`. + /// `ancestor(1)` is equivalent to `parent()`. /// /// If `level` is out of bounds (above `Program`), returns `Ancestor::None`. ///