-
-
Notifications
You must be signed in to change notification settings - Fork 22
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
Haddock all the things! #27
Comments
I'd like to work on this. |
@InfiniteVerma go for it! 👍🏻 Note, that you don't need to document everything in a single PR. You can document only some bits. Every contribution helps the project 😌 |
@chshersh I'm attempting to add a doctest to a function. I would like to know if one can test a function that returns IO. |
@InfiniteVerma You can test IO functions as well with |
Lots of functions are missing the documentation. It would be great to add more!
This issue is an excellent way to start contributing to Iris 🤗
See a function that doesn't have a proper explanation? Feel free to add it and it would be especially great if you can add a
doctest
example! 👏🏻You can document as many functions as you want in a single PR, or you can open multiple PRs. This issue is a call for contributors 😊
The following documentation changes are especially appreciated:
doctest
-like usage examplesThe text was updated successfully, but these errors were encountered: