["Request"] API docs are missing for various apis

[myuwono]

What version are you currently using?
1.2.0-RC

What would you like to see?

User that is new to the library can benefit from a better API documentation. The api docs can be improved by providing description, use cases, and example code. While some API docs are really well documented, some functions were missing documentation.

These are the api docs, for instance can be improved:

• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/either.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/ensure.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/ensure-not-null.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/ior.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/nullable.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/-nullable-raise/index.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/option.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/-option-raise/index.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/-raise-accumulate/index.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/result.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/-result-raise/index.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/to-either.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/effect.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/to-result.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/to-option.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/-trace/index.html
• https://apidocs.arrow-kt.io/arrow-core/arrow.core.raise/zip-or-accumulate.html

[nomisRev]

Thank you for the issue @myuwono! 🙏

[myuwono]

Thank you @nomisRev! @jbunton-atlassian kindly pointed it out for us. I just raised an issue to track it on his behalf. I believe it is a small gap that can be addressed to help improve adoption.

Kudos to Arrow team, thank you for all the amazing things and kindly listening to our voices, simplifying the library and building such an amazing community.

The API surface has shrunk significantly with the simplifications, so it seems relatively manageable. So I'm also keen to help a few. Keen to approach this incrementally. I can see #3038 which is a doco for ensure. I'll try raising one or two kdocs on perhaps either builder or option builder this week..

[myuwono]

Looks like a duplicate of #3037