Indicate category and option name in error message when validating settings dialog#16352
Merged
Conversation
Contributor
|
FWIW I quite like the 12pt blue and 9pt black created by the empty line. It has good visual semantics, better than the other two options. |
Contributor
Author
|
Thanks @gerald-hartig for your feedback. |
lukaszgo1
reviewed
Apr 4, 2024
seanbudd
approved these changes
Apr 16, 2024
| option=option, | ||
| ), | ||
| # Translators: The title of the message box | ||
| caption=_("Error"), |
Member
There was a problem hiding this comment.
Suggested change
| caption=_("Error"), | |
| caption=_("Invalid settings"), |
Contributor
Author
There was a problem hiding this comment.
Shouldn't it rather be "Invalid setting" with singular form. Only one invalid setting is reported in each dialog.
Or is "settings" always with a final "s" in English?
@seanbudd, feel free to commit yourself the more suitable proposal.
Suggested change
| caption=_("Error"), | |
| caption=_("Invalid setting"), |
Collaborator
|
@CyrilleB79 I was going to suggest "invalid configuration", but "invalid
setting" is also fine. "settings" is not correct for a single setting.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Link to issue number:
None
Summary of the issue:
The settings dialog contains always more error message boxes appearing when the validation of a parameter fails: modes available in cycle speech mode command or in cycle sound split mode command and regex validation in advanced settings have been added recently.
These messages do not formally mention the panel, nor the option which they are associated with. This may be difficult for the user to know which option is causing the error when the user has been modifying various settings in various setting panels (categories) before validating with "OK" or "Apply".
Description of user facing changes
The validation error messages now indicate the category and the name of the option which is causing the error so that the user can go to this option and modify it.
Description of development approach
Create a common dedicated error validation message with appropriate placeholders to be filled.
Testing strategy:
Visual test
Sighted people collaboration needed please. Cc @Qchristensen, @gerald-hartig
The current aspect of the dialog is as follows:
The initial error message is written bigger (12 pt) and in aqua-blue color. The additional information (category and options) is written smaller (9 pt) and in black color.
This difference was not done on purpose and seems due to the empty line that I have added between the initial error text and the additional information.
If I remove this empty line, the dialog would becomes as follows, with all the text written in black, size 9pt:
What is the best appearance according to you?
Or should I explore a third solution, e.g. all the text in 9pt black, but with a blank line between first error text and additional information? I do not know if it is easily doable...
Known issues with pull request:
None
Change log
Not needed IMO.
Code Review Checklist: