Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Library error messages about invalid data should explain how the data is invalid #125

Open
mr-smidge opened this issue Jul 22, 2024 · 0 comments
Labels
good first issue Good for newcomers

Comments

@mr-smidge
Copy link
Contributor

Some error messages emitted from the library, when invalid data is encountered, explain vaguely that something is wrong, but could be clearer in explaining how that data is invalid.

For example:

    if (raw_data.size() < 27)
    {
        throw std::invalid_argument{
            "Overview waveform data has less than the minimum length of "
            "27 bytes"};
    }

The above message would be more helpful if it explained how many bytes the raw data actually was.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant