Documentation needs data examples and not just code
Open
@koperagen is already working on this.
Since Jan 24, 2023.
- Dominant language
- Kotlin
- Stars
- 1.1k
- Forks
- 83
- Avg merge
- 4d 12h
- Merged PRs (30d)
- 30
Description
It's hard to understand the docs because they present how to program the API but do not illustrate the result.
E.g. comparing https://dplyr.tidyverse.org/reference/summarise.html with https://kotlin.github.io/dataframe/groupby.html#aggregation it becomes clear (to me at least) that data examples are very helpful to understand a table processing API.
Expected: The docs should inline the results of the various API examples.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.