open-ephys / liboni

API for controlling ONI-compliant hardware
https://open-ephys.github.io/onix-docs/API%20Reference/index.html
0 stars 5 forks source link

Review error strings #26

Open jonnew opened 3 months ago

jonnew commented 3 months ago

The error strings in this library often find themselves elevated all the way to the user. It is therefore very important that they are clear. We need to review each of these strings and make sure they describe, succinctly and accurately, what the error code means in an actionable way.

A particularly bad example is the following:

https://github.com/open-ephys/liboni/blob/dababf06f10449e4de0ce2c67176081d4f24342b/api/liboni/oni.c#L852

Which should be replaced by something like "Device register access is ongoing and must complete before another is started"