Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation #130

Closed
dereuromark opened this issue Aug 25, 2016 · 5 comments · Fixed by #270
Closed

Improve documentation #130

dereuromark opened this issue Aug 25, 2016 · 5 comments · Fixed by #270
Projects

Comments

@dereuromark
Copy link

For those not too experienced with what SpoofCheck or NoRfcWarning would actually do, and what the pitfalls or possible false positives could be, it can be rather confusing.
Each validator is a bit under-documented at the moment.
It would be good to have a small human readable paragraph to each of them either in the readme or some dedicated documentation.

@egulias
Copy link
Owner

egulias commented Aug 25, 2016

Yes, I agree.
BTW, do you think cakephp could benefit from this validator?

@dereuromark
Copy link
Author

dereuromark commented Aug 25, 2016

As a plugin i would definitly say so.
Unfortunately my tests so far were false positive.
An invalid Email got marked as valid with this tool.

@egulias
Copy link
Owner

egulias commented Aug 25, 2016

Would you mind providing those false positives to improve the lib?

@dereuromark
Copy link
Author

Maybe we can discuss that via email? Don't want to publish those here. You can find mine on my profil/blog etc. Thanks!

@kevindb
Copy link

kevindb commented Sep 8, 2020

I would also like to request clarification on what the strategies are. I cannot figure out which I want to use between the available validations. In particular, RFCValidation and NoRFCWarningsValidation. Even just a one sentence description of each would be helpful!

@egulias egulias added this to To do in V3 via automation Oct 3, 2020
@egulias egulias moved this from To do to In progress in V3 Oct 31, 2020
egulias added a commit that referenced this issue Nov 7, 2020
@egulias egulias mentioned this issue Nov 7, 2020
V3 automation moved this from In progress to Done Nov 7, 2020
egulias added a commit that referenced this issue Nov 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
V3
  
Done
Development

Successfully merging a pull request may close this issue.

3 participants