Skip to content
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

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

Open
nomisRev opened this issue Apr 8, 2023 · 1 comment
Open

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

nomisRev opened this issue Apr 8, 2023 · 1 comment

Comments

@nomisRev
Copy link
Member

nomisRev commented Apr 8, 2023

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

@ILIYANGERMANOV
Copy link
Contributor

ILIYANGERMANOV commented Apr 10, 2023

Raised a small PR that improves the KDoc around Raise:
#3038

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants