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.

Sign up for GitHub

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

Jump to bottom

Add docs #8

Open
chrisfishwood opened this issue Jan 15, 2017 · 0 comments
Open

Add docs #8

chrisfishwood opened this issue Jan 15, 2017 · 0 comments

Comments

@chrisfishwood
Copy link
Contributor

We have no docs, but we are generating them. We should have docs.
awochna added a commit to awochna/validator that referenced this issue Jun 21, 2017
@awochna
Add relatively basic but complete documentation for Validator.
4ebe74b 
Examples are given in the documentation, but doctests have been disabled
because of the complex setup required for a valid struct and changeset
to use. Instead, we just magically assume one is there for us.

Also, set the index page of the documentation to the README. Personally,
I find this helpful as a springboard into the rest of the documentation,
but feel free to change it.

Note that the explanation around the 3rd argument to our fuctions
(`opts`) is kind of weak. I'm not sure what options are supported and
what they do based on what's here. As far as I can tell, it allows you
to customize the invalid message, so I just left it at that. Feel free
to bolster it.

Closes fourkio#8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@chrisfishwood