Skip to content

Add KDocs for mean.kt - #2102

Merged
Jolanrensen merged 16 commits into
masterfrom
junie/mean-kdocs-1972
Sep 30, 2026
Merged

Jolanrensen merged 16 commits into
masterfrom
junie/mean-kdocs-1972

Conversation

@Jolanrensen

@Jolanrensen Jolanrensen commented Sep 22, 2026 •

Copy link
Copy Markdown
Collaborator

** Generated with Air/Junie **

Description

Adds full KoDEx-based KDocs for the mean operation (DataColumn.mean/meanOf, DataRow.rowMean/rowMeanOf, DataFrame.mean/meanFor/meanOf, Grouped.mean/meanFor/meanOf, Pivot.mean/meanFor/meanOf, PivotGroupBy.mean/meanFor/meanOf), following the same style already used for sum, min, and max.

Closes #1972

Changes

  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt: replaced the old TODO KDocs comment with a proper // region docs block (MeanDocs : CommonStatisticsDocs) and per-overload KDocs, reusing shared CommonStatisticsDocs snippets (null/NaN handling, etc.) to avoid duplicating documentation text.
  • core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt: added DocumentationUrls.Mean (+ TypeConversion) linking to the existing mean.html documentation page.

Verification

  • ./gradlew :core:compileKotlin — success
  • ./gradlew :core:ktlintMainSourceSetCheck — success
  • ./gradlew :core:processKDocsMain — success, no unresolved KoDEx references
  • ./gradlew :core:test --tests "*mean*" --tests "*Mean*" — success

Additionally, I checked all generated text, moved some extra KDocs to CommonStatisticsDocs, and I added some extra notes to min and max that we added to sum and could be useful there too.

@Jolanrensen
Jolanrensen marked this pull request as draft September 22, 2026 15:24
jetbrains-air[bot]

This comment was marked as resolved.

@Jolanrensen
Jolanrensen marked this pull request as ready for review September 23, 2026 14:52
@Jolanrensen Jolanrensen added the KDocs Improvements or additions to KDocs label Sep 23, 2026
jetbrains-air[bot]

This comment was marked as resolved.

@Jolanrensen
Jolanrensen added this pull request to stack #2108 September 25, 2026 11:26
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/max.kt
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt Outdated
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt Outdated
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt Outdated
Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt
@Jolanrensen

Copy link
Copy Markdown
Collaborator Author

@Allex-Nik thanks! Very good review once again :)

Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt Outdated
@Allex-Nik
Allex-Nik self-requested a review September 29, 2026 15:34

@Allex-Nik Allex-Nik left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool! I like the docs

Only #2102 (comment) is left to process one way or another :)

@jetbrains-air jetbrains-air Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the thorough pass on these docs — one thing to sort out before merge!

Produced by Air Automations. Name: AI Review / Run: https://air.jetbrains.cloud/org/05cf1a7f-6ab5-713b-abd3-29d0c8a05e2d/automations/8daf2412-0b6c-4433-90c0-b40ab5aebcdb?run=f9fd8a0a-ccc9-45a5-aba9-a14f9961b77c

Comment thread core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/mean.kt Outdated
@Jolanrensen
Jolanrensen merged commit 47c80ed into master Sep 30, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

KDocs Improvements or additions to KDocs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add KDocs for non-deprecated mean APIs

2 participants