Knockout-Contrib / Knockout-Contrib/Knockout-Validation
Misleading wiki about message overrides
- Dominant language
- JavaScript
- Stars
- 1k
- Forks
- 366
- PR merge metrics
- No merged PRs in 30d
Description
Not sure if introducing `mustEqual` was intentional in [1] but as there is built-in `equal` rule I think it should be replaced with `equal` or described in the other section (for peoples who scans not reads text) about overriding _native_ rules like:
``` js
var vm = {
acceptedTerms = ko.observable(false).extend({
required: true,
equal: {
params: true,
message: 'You must accept Terms and Conditions.'
},
});
}
```
[1] https://github.com/Knockout-Contrib/Knockout-Validation/wiki/Override-Error-Messages
Contributor guide
Research direction
Open the Knockout-Validation wiki page “Override Error Messages” linked in the issue and compare its use of mustEqual with the built-in equal rule. Update the misleading section or example so native-rule message overrides are described consistently, including the provided equal example.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100