arrow icon indicating copy to clipboard operation
arrow copied to clipboard

["Request"] Do a pass on documentation, and examples in KDoc

Open nomisRev opened this issue 2 years ago • 1 comments

What version are you currently using?

1.2.0-RC

What would you like to see?

The KDoc is minimal and lacks examples. For example, on raise() we have just "Raise a logical failure of type Error". Btw GPT-4 generate killer docs if you give him some context and good prompts - ofc it needs human verification but it can greatly speed-up the docs process.

https://kotlinlang.slack.com/archives/C5UPMM0A0/p1680904729946789

nomisRev avatar Apr 08 '23 09:04 nomisRev

Raised a small PR that improves the KDoc around Raise: https://github.com/arrow-kt/arrow/pull/3038

ILIYANGERMANOV avatar Apr 10 '23 13:04 ILIYANGERMANOV