Inaccurate and confusing error message

OpenCyphal / yakut

Simple CLI tool for diagnostics and debugging of Cyphal networks

https://opencyphal.org

MIT License

49 stars 10 forks source link

Open pavel-kirienko opened 2 years ago

pavel-kirienko commented 2 years ago

Even if the uavcan namespace is available, you may get this error which is incorrect and badly misleading:

$ y sub 24:uavcan.nonexistent.nested
NotFoundError: Run `yakut compile <path>/uavcan` to compile DSDL namespace 'uavcan'

The problem is not that uavcan is not available (it is!) but rather that it doesn't contain uavcan.nonexistent.

If the last part .nested is removed, we get the correct error message:

NotFoundError: Could not locate nonexistent.*.* in module 'uavcan'

pavel-kirienko commented 2 years ago

The culprit is here:

The error message generated by make_usage_suggestion() is misleading and should be improved as follows:

Instead of a mere namespace name the function should accept the full name of the desired data type.
The error message should be more verbose, saying which data type is missing, and suggesting that perhaps the entire namespace needs to be recompiled.