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

Use user-/idiot-friendly error messages in settings command #343

Open
2 tasks
lionkor opened this issue Jun 26, 2024 · 0 comments
Open
2 tasks

Use user-/idiot-friendly error messages in settings command #343

lionkor opened this issue Jun 26, 2024 · 0 comments
Labels
feature New feature or request good first issue Good for newcomers

Comments

@lionkor
Copy link
Member

lionkor commented Jun 26, 2024

Currently, mistyping settings could confuse users who mistype settings.

Acceptance criteria

  • Use simple language to convey what the error is, for example "unknown setting", "unknown category" (or similar) when users use an invalid category or setting.
  • Hint at possible errors using language such as "Maybe it was spelled wrong", "use settings list to get a list of all valid settings", "setting names are case sensitive", bla.

Notes:

  • It's probably easiest to swap logic/runtime error types for custom exception types and then catch them via a } catch (InvalidCategory e) {...} catch (InvalidKey e) { ... } ... etc.
  • You can write a grammar for the settings, using e.g. boost::spirit
@lionkor lionkor added feature New feature or request good first issue Good for newcomers labels Jun 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants