Kotlin / Kotlin/dataframe

Improve discoverability and completeness of aggregation/statistics documentation

Open
#210 2 comments 0 reactions 1 assignee View on GitHub

@Allex-Nik is already working on this.

Since Mar 26, 2026.

documentation
Dominant language
Kotlin
Stars
1.1k
Forks
83
Avg merge
4d 12h
Merged PRs (30d)
30

Description

Problem

Aggregation/statistics functionality is hard to discover and inconsistently documented.

Specifically:

  • Statistics documentation is difficult to find from relevant pages
  • Naming conventions (x, xOf, xFor) are not clearly explained in one place
  • Some existing examples (e.g. from Analyze.kt) are not used in documentation
Expected

Improve discoverability and ensure documentation completeness for aggregation/statistics APIs.

Acceptance criteria
  • Statistics documentation is linked from relevant pages (e.g. operations, KDocs)
  • Naming conventions (x, xOf, xFor) are explained in one place and referenced
  • Unused examples are either:
    • added to documentation, or
    • removed
  • Documentation allows users to find statistics APIs without prior knowledge
Motivation
  • Aggregation is a core part of data analysis workflows
  • Poor discoverability leads to underused or misunderstood functionality
  • Documentation must be navigable and complete before 1.0
  1. It was hard to find information about https://kotlin.github.io/dataframe/summarystatistics.html. I tried to search "naming conventions" to refresh memories about "xFor, xOf, x". Found only https://kotlin.github.io/dataframe/modify.html#naming-conventions. I also forgot Statistics even exists :o Maybe we might add links to documentation in kdocs? But i'm not sure if i ever seen people doing it and if it's a good / bad practice

  2. There are samples are never used across documentation, like columnStats_properties or multipleColumnsStat and some other from Analyze.kt

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.