theseion / Fuel

Fuel, the Smalltalk object serializer
https://theseion.github.io/Fuel
MIT License
26 stars 12 forks source link

Debugging: Document Its Obsolescence #285

Closed seandenigris closed 9 months ago

seandenigris commented 9 months ago

The docs are out-of-date as they reference the old API, but the primary issue is that the debug hooks seem to have vanished.

After loading Fuel-Debug, there doesn't seem to be any implementors of setDebug. FLDebugMaterialization is not referenced. Checking references of FLMaterialization, I found the apparent place to manually hack in debugging:

Screenshot 2023-10-17 at 6 11 25 AM

but there should be a supported hook.

Also, I was not clear how the debug output is helpful or what to do with it:

Screenshot 2023-10-17 at 6 13 05 AM
theseion commented 9 months ago

I've never really used the debug package myself. Never found it very useful. That's why I stopped supporting it.

seandenigris commented 9 months ago

Thanks for the explanation!

seandenigris commented 9 months ago

Maybe a disclaimer in the docs at the beginning of the debug section clarifying that it's no longer supported?

theseion commented 9 months ago

Yes, good idea.

theseion commented 9 months ago

https://theseion.github.io/Fuel/debugging/

seandenigris commented 9 months ago

Thanks!