JuliaSymbolics/SymbolicUtils.jl

Confusing Documentation: Relation to TermInterface.jl

samysweb opened this issue · 0 comments

Hello,
after about 4 hours of debugging a version update of SymbolicUtils.jl today, I stumbled across this commit.
It is my understanding that SymbolicUtils.jl is now working independently from TermInterface.jl and one should therefore no longer implement istree,operation,arguments, etc. for TermInterface, but for SymbolicUtils directly.
This is an important distinction, because my custom interfacing with SymbolicUtils so far looked as below which does not work with the new version of SymbolicUtils that has the TermInterface integrated into its own code base.

import TermInterface.istree
# ...

istree(x::MyType) = true
# ...

It would be nice to eventually have an update for the documentation on interfacing concerning this change since it currently still tells you to interface with TermInterface which will not work and is a terrible thing to debug by hand.
I'm mainly opening this issue so that other people with similar problems may find it until the documentation has been updated accordingly.

Nonetheless, thank you very much for your great work on this project, it has really helped me a lot in my project!