Rename the isequal2 function to isequal_with_metadata for clarity.

Author: bowenszhu

src/types.jl

@@ -287,7 +287,7 @@ Modifying `Base.isequal` directly breaks numerous tests in `SymbolicUtils.jl` an
 downstream packages like `ModelingToolkit.jl`, hence the need for this separate
 function.
 """
-function isequal2(a::BasicSymbolic, b::BasicSymbolic)::Bool
+function isequal_with_metadata(a::BasicSymbolic, b::BasicSymbolic)::Bool
     isequal(a, b) && isequal(metadata(a), metadata(b))
 end
 
@@ -362,23 +362,23 @@ Implements hash consing (flyweight design pattern) for `BasicSymbolic` objects.
 This function checks if an equivalent `BasicSymbolic` object already exists. It uses a 
 custom hash function (`hash2`) incorporating metadata and symtypes to search for existing 
 objects in a `WeakValueDict` (`wvd`).  Due to the possibility of hash collisions (where 
-different objects produce the same hash), a custom equality check (`isequal2`) which 
-includes metadata comparison, is used to confirm the equivalence of objects with matching 
-hashes. If an equivalent object is found, the existing object is returned; otherwise, the 
-input `s` is returned. This reduces memory usage, improves compilation time for runtime 
-code generation, and supports built-in common subexpression elimination, particularly when 
-working with symbolic objects with metadata.
+different objects produce the same hash), a custom equality check (`isequal_with_metadata`) 
+which includes metadata comparison, is used to confirm the equivalence of objects with 
+matching hashes. If an equivalent object is found, the existing object is returned; 
+otherwise, the input `s` is returned. This reduces memory usage, improves compilation time 
+for runtime code generation, and supports built-in common subexpression elimination, 
+particularly when working with symbolic objects with metadata.
 
 Using a `WeakValueDict` ensures that only weak references to `BasicSymbolic` objects are 
 stored, allowing objects that are no longer strongly referenced to be garbage collected. 
-Custom functions `hash2` and `isequal2` are used instead of `Base.hash` and `Base.isequal` 
-to accommodate metadata without disrupting existing tests reliant on the original behavior 
-of those functions.
+Custom functions `hash2` and `isequal_with_metadata` are used instead of `Base.hash` and 
+`Base.isequal` to accommodate metadata without disrupting existing tests reliant on the 
+original behavior of those functions.
 """
 function BasicSymbolic(s::BasicSymbolic)::BasicSymbolic
     h = hash2(s)
     t = get!(wvd, h, s)
-    if t === s || isequal2(t, s)
+    if t === s || isequal_with_metadata(t, s)
         return t
     else
         return s

test/basics.jl

@@ -1,4 +1,4 @@
-using SymbolicUtils: Symbolic, Sym, FnType, Term, Add, Mul, Pow, symtype, operation, arguments, issym, isterm, BasicSymbolic, term, isequal2
+using SymbolicUtils: Symbolic, Sym, FnType, Term, Add, Mul, Pow, symtype, operation, arguments, issym, isterm, BasicSymbolic, term, isequal_with_metadata
 using SymbolicUtils
 using IfElse: ifelse
 using Setfield
@@ -340,9 +340,9 @@ end
     a1 = setmetadata(a, Ctx1, "meta_1")
     a2 = setmetadata(a, Ctx1, "meta_1")
     a3 = setmetadata(a, Ctx2, "meta_2")
-    @test !isequal2(a, a1)
-    @test isequal2(a1, a2)
-    @test !isequal2(a1, a3)
+    @test !isequal_with_metadata(a, a1)
+    @test isequal_with_metadata(a1, a2)
+    @test !isequal_with_metadata(a1, a3)
 end
 
 @testset "subtyping" begin