Improve documentation #59
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Added some more docs. Still have write documentation for |
readme.md
Outdated
| Create a reusable validator. | ||
|
|
||
| ```ts | ||
| import ow from 'ow'; |
There was a problem hiding this comment.
I don't think we need the import here for each example. It's implied.
There was a problem hiding this comment.
Yes, I was back and forth on it. Will remove it.
|
Great start! Can you also run |
|
Done. Anything else you think we are missing besides |
|
I think it will be good when |
|
Just not sure yet how we should document them, as they are modifiers on every predicate. |
Closed
SamVerschueren
changed the title
What you ended up with is good :) |
SamVerschueren
added a commit
that referenced
this pull request
Apr 26, 2018
SamVerschueren
added a commit
that referenced
this pull request
Apr 26, 2018
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is a start to write better documentation in the readme. I'm just writing stuff down as I'm entirely not sure on the format. So feedback is more than welcome :)!
PR is very much WIP (train arrived ;)).