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
-
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
-
There are samples are never used across documentation, like columnStats_properties or multipleColumnsStat and some other from Analyze.kt
Problem
Aggregation/statistics functionality is hard to discover and inconsistently documented.
Specifically:
x,xOf,xFor) are not clearly explained in one placeExpected
Improve discoverability and ensure documentation completeness for aggregation/statistics APIs.
Acceptance criteria
x,xOf,xFor) are explained in one place and referencedMotivation
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
Statisticseven 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 practiceThere are samples are never used across documentation, like
columnStats_propertiesormultipleColumnsStatand some other from Analyze.kt