Hi !
I believe that kwalify would benefit to allow a comment field in its schemas.
Example :
type map:
mapping:
"id":
type: int
required: yes
comment: This is a unique id bla bla bla
Kwalify itself would ignore that field, so you might ask, why not use a simple yaml comment instead ?
Well, in my case, that would *not* be enough. I am using yaml AND kwalify to implement and describe a network protocol. I was hoping that a schema file, with good yaml comments, would be clear enough to be checked and okayed by my boss and the customer. But the customer *wants*, at the end of the day, a word file with the complete specification of the protocol.
That's why I am writing a program which takes a kwalify schema and presents it in html (word can understand simple html). The comment field is cleary needed in my case, but I believe there could be other automatic tools that work with kwalify schema which would benefit such a field.
What do you think ?
Thanks for all the great work by the way. If you don't think this is a good idea, I will always be able to easily modify meta-validator.rb, which is perfectly fine !