-
-
Notifications
You must be signed in to change notification settings - Fork 146
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鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
Documentation needs to have examples #305
Comments
Chiming in here with the same sentiment. A lack of examples and at least a description of what the types do makes this (probably great) library much less useful than it could be. Here are some of the things that would help the docs site:
For reference, here are just a few of the other tickets describing docs/examples related topics: |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
馃悶 Bug Report
Describe the bug
It would appear that by randomly clicking types in the documentation, a great number, if not most of the types do not have examples nor do they declare their intent. Because of this I find this library to be incredibly difficult to make use of. actually I don't because I can never tell if its types can help solve my problem, or how to actually use them. It would be incredibly useful if someone(s) were to make a concerted effort to increase documentation coverage and ensure new types were covered to a higher standard.
The text was updated successfully, but these errors were encountered: