Skip to content

Commit

Permalink
docs(traverse): tidy doc comments for TraverseCtx::is_static (#7267)
Browse files Browse the repository at this point in the history
Better describe what this method does in its doc comment, and tidy up wording a little.
  • Loading branch information
overlookmotel committed Nov 13, 2024
1 parent 7a48728 commit 834c94d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 9 deletions.
6 changes: 3 additions & 3 deletions crates/oxc_traverse/src/context/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -545,12 +545,12 @@ impl<'a> TraverseCtx<'a> {

/// Determine whether evaluating the specific input `node` is a consequenceless reference.
///
/// I.E evaluating it won't result in potentially arbitrary code from being ran. The following are
/// allowed and determined not to cause side effects:
/// i.e. evaluating it won't result in potentially arbitrary code from being run.
/// The following are allowed and determined not to cause side effects:
///
/// - `this` expressions
/// - `super` expressions
/// - Bound identifiers
/// - Bound identifiers which are not mutated
///
/// This is a shortcut for `ctx.scoping.is_static`.
#[inline]
Expand Down
9 changes: 3 additions & 6 deletions crates/oxc_traverse/src/context/scoping.rs
Original file line number Diff line number Diff line change
Expand Up @@ -353,18 +353,15 @@ impl TraverseScoping {

/// Determine whether evaluating the specific input `node` is a consequenceless reference.
///
/// I.E evaluating it won't result in potentially arbitrary code from being ran. The following are
/// allowed and determined not to cause side effects:
/// i.e. evaluating it won't result in potentially arbitrary code from being run.
/// The following are allowed and determined not to cause side effects:
///
/// - `this` expressions
/// - `super` expressions
/// - Bound identifiers
/// - Bound identifiers which are not mutated
///
/// Based on Babel's `scope.isStatic` logic.
/// <https://github.com/babel/babel/blob/419644f27c5c59deb19e71aaabd417a3bc5483ca/packages/babel-traverse/src/scope/index.ts#L557>
///
/// # Panics
/// Can only panic if [`IdentifierReference`] does not have a reference_id, which it always should.
#[inline]
pub fn is_static(&self, expr: &Expression) -> bool {
match expr {
Expand Down

0 comments on commit 834c94d

Please sign in to comment.