Kotlin / Kotlin/dataframe

☂ Provide KDocs for public API: Continued

Open
#811 0 comments 0 reactions 3 assignees Claimed by @Jolanrensen View on GitHub
☂ umbrella issue KDocs
Dominant language
Kotlin
Stars
1.1k
Forks
83
Avg merge
4d 12h
Merged PRs (30d)
30

Description

Continuation of https://github.com/Kotlin/dataframe/issues/286.

Now we have a [KDoc preprocessing wiki/guide](https://github.com/Kotlin/dataframe/blob/master/KDOC_PREPROCESSING.md) (https://github.com/Kotlin/dataframe/issues/805), we can continue documenting the public API.

I'll make a small collection of operations that we can document together to start getting the hang of it. This will be an umbrella issue:

- https://github.com/Kotlin/dataframe/issues/814 (simple)
- https://github.com/Kotlin/dataframe/issues/817 (simple)
- https://github.com/Kotlin/dataframe/issues/819 (simple)
- https://github.com/Kotlin/dataframe/issues/1020 (not that simple)
- https://github.com/Kotlin/dataframe/issues/815 (a bit more advanced)
- https://github.com/Kotlin/dataframe/issues/813 (a bit more advanced)
- https://github.com/Kotlin/dataframe/issues/820 (a bit more advanced)
- https://github.com/Kotlin/dataframe/issues/1019 (a bit more advanced)
- https://github.com/Kotlin/dataframe/issues/816 (advanced)
- https://github.com/Kotlin/dataframe/issues/821 (very advanced)

If you want to use an operation as an example, I'd recommend looking at [select](https://github.com/Kotlin/dataframe/blob/master/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/select.kt).

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.