Haddock all the things!

[chshersh]

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:

• Typos, spelling and grammar fixes
• Adding doctest-like usage examples
• Explanations on how to use functions and when
• Documentations to data type fields
• Docs to function arguments and result types
• Anything else!

[InfiniteVerma]

I'd like to work on this.

[chshersh]

@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 😌

[InfiniteVerma]

@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.

[chshersh]

@InfiniteVerma You can test IO functions as well with doctest. The official documentation has an example:

• https://github.com/sol/doctest#multi-line-output