As an editor, I want additional clarification on how I can create a more accurate value for my problematic data in order to create cleaner data.
As a data modeller, I want other editors to understand why their edits are violating constraints, and how they can fix it in order to standardise our data.
Problem:
When a constraint violation is triggered not enough information is provided to the editor for them to understand the issue. By providing clarification for editors to understand the constraint violations, editors will be able to standardise data modelling more easily.
@ArthurPSmith created the constraint clarification property as a way to make Property constraints more understandable for other editors who try to add data that violate these constraints.
By adding the constraint clarification in the constraint violation message, users will be able to understand how to create more accurate values for their problematic data.
This needs to be supported by the Wikibase Quality Constraints Extension.
Example:
Current state:
Example constraint clarification:
Example from sandbox:
Screenshots/mockups:
Mock-up and specs of the new constraint violation message.
The constraint clarification is added as a new paragraph below the constraint definition in the violation message.
BDD
GIVEN an editor adds a value that triggers a constraint violation
AND there is a constraint defined for the property
AND that has a constraint clarification
WHEN the constrain violation is triggered
AND the editor clicks the flag
THEN they are able to see a message from the constraint clarification that explains why that value violates the constraints of the Property
Acceptance criteria:
- Constraint clarification is shown when a constraint violation flag is clicked
Open questions:
If a constraint clarification exists, but not in the language of the user how will this be shown?
We decided that we would use the same language fallback as the syntax clarification.
Original ticket:
@ArthurPSmith just created the constraint clarification property; see the property proposal for discussion on how it can be used to improve violation messages. Assuming the community adopts it, we should include these clarifications in constraint violation messages.
