search

lukejagodzinski / meteor-astronomy-validators

https://atmospherejs.com/jagi/astronomy-validators
MIT License
11 stars 13 forks source link

Documentation is invalid : getErrors #5

Closed parhelium closed 9 years ago

parhelium commented 9 years ago

It looks like in docs you are using convention : post.getErrors(), but in code it is undefined. However previous version post.getValidationErrors() works fine. The same thing happens for other methods.

lukejagodzinski commented 9 years ago

Yes right, sorry for that. I can keep up correlation between documentation and the code because many things are rapidly changing. I will fix that :). Thanks for informing.

parhelium commented 9 years ago

Do you plan to strip word Validation from all methods in the future ?

lukejagodzinski commented 9 years ago

I had this idea but finally I've decided that the Validation world will stay there. Of course stripping it would make methods sorter and the code more minimalistic but I prefer descriptive method names. When seeing getErrors, we don't know what errors. But getValidationErrors is obvious. I was changing mind in this manner lately but I've chosen longer names. I hope it's now a big problem? Maybe do you have some clue, idea about naming?

parhelium commented 9 years ago

I like more descriptive names either. I think it is good idea to stay with getValidationErrors naming.

lukejagodzinski commented 9 years ago

Ok so I will stay with descriptive names