-
Notifications
You must be signed in to change notification settings - Fork 4
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
DOC: Improve user-facing documentation #49
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks like a really good start. I don't have strong opinions on the organization, so if you like it, then I think we can go for it. If you have places where you are unsure we could discuss it.
Codecov Report
@@ Coverage Diff @@
## master #49 +/- ##
=======================================
Coverage 80.75% 80.75%
=======================================
Files 18 18
Lines 1195 1195
=======================================
Hits 965 965
Misses 230 230
Continue to review full report at Codecov.
|
[ci skip]
[ci skip]
[ci skip]
Currently, the rendered API doc for |
The rendered version of this looks good. There are places where I really should write better documentation about what each of these vetters do. I didn't see anything wrong, it is just very terse. I'd say go ahead and merge when you are ready. |
Okay, I merged it. Thanks for the review! I'll continue in a separate PR after #54 is resolved. |
As requested by @mustaric .
TODO