play framework

Built-in validations are not documented

Bug #620046 reported by niels
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
play framework
Fix Committed
Undecided
Peter Hilton

Bug Description

I don't find a complete documentation of all included validations. For CustomValidation it's not clear how to define the errormessage. I assume Validation.addError.
Only small issues but Peter from Lunatech said he's watching for such small reports.

Peter Hilton (pedro-lunatech)
summary: - validation are not documented
+ Built-in validations are not documented
Changed in play:
status: New → Confirmed
assignee: nobody → Peter Hilton (pedro-lunatech)
Peter Hilton (pedro-lunatech)
Changed in play:
status: Confirmed → In Progress
Revision history for this message
Peter Hilton (pedro-lunatech) wrote :

Draft for review: http://www1.lunatech.com/~pedro/play/validation-builtin.html

Revision history for this message
niels (opensource21) wrote :

Checked for completeness, against the package play.data.validation. Is complete, except Password. But Password isn't really a Check, so it OK.
I read the text an it seems correct, but my English is bad, so I can't make a check for correct spelling and grammar.

Still open:
"For CustomValidation it's not clear how to define the errormessage. I assume Validation.addError."

After making the review I assume I must wrote
@CheckWith(MyPasswordCheck.class, message="My message Text")
or define an own annotation, what isn't documented too :-/ Look like a hard job to complete the documentation.
Thanks for the draft.

Peter Hilton (pedro-lunatech)
Changed in play:
status: In Progress → Fix Committed
Revision history for this message
niels (opensource21) wrote :

Some of the validations has message variables. I think it would be good if them are documented too and how the string in the message properties should be formatted.

To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.