Skip to content

Update kdoc helpers#1683

Open
AndreiKingsley wants to merge 30 commits intomasterfrom
update-kdoc-helpers
Open

Update kdoc helpers#1683
AndreiKingsley wants to merge 30 commits intomasterfrom
update-kdoc-helpers

Conversation

@AndreiKingsley
Copy link
Collaborator

@AndreiKingsley AndreiKingsley commented Feb 16, 2026

Closes #1688.
Closes #1654.

Jolanrensen and others added 20 commits November 3, 2025 21:43
…pe-aliases in :core, saving 400KB of jar size
# Conflicts:
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
# Conflicts:
#	build.gradle.kts
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/distinct.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/groupBy.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/pivot.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/rename.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/AccessApi.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/ExtensionPropertiesAPI.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/SelectingColumns.kt
#	dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentationCsv/DelimParams.kt
#	gradle/libs.versions.toml
# Conflicts:
#	build.gradle.kts
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/distinct.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/groupBy.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/pivot.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/rename.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/AccessApi.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/DocumentationUrls.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/ExtensionPropertiesAPI.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/SelectingColumns.kt
#	dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentationCsv/DelimParams.kt
#	gradle/libs.versions.toml
…-kdoc-helpers

# Conflicts:
#	build.gradle.kts
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/distinct.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/groupBy.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/pivot.kt
#	core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/rename.kt
#	dataframe-csv/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentationCsv/DelimParams.kt
#	gradle/libs.versions.toml
@AndreiKingsley
Copy link
Collaborator Author

Currently blocked by KoDeX issue: Jolanrensen/KoDEx#97.

@AndreiKingsley
Copy link
Collaborator Author

  1. Improvements to the KDoc helpers will continue as a new issue (Improve KDoc-snippets usages #1713).
  2. I will udate information in KDOC_PREPROCESSING.md in KDocs guidelines #1660.

@AndreiKingsley AndreiKingsley marked this pull request as ready for review February 27, 2026 13:38
* If both [DataFrame]s contain columns with the same name that are *not* part of the join keys,
* such columns are treated as distinct. Such a column from the right [DataFrame] will be
* [automatically renamed][org.jetbrains.kotlinx.dataframe.documentation.AutoRenaming]
* [automatically renamed][`Auto-renaming columns in DataFrame`]
Copy link
Collaborator

Choose a reason for hiding this comment

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

backticks in name of reference; cannot be expanded to FQ name if JoinBehavior is included elsewhere

Copy link
Collaborator

Choose a reason for hiding this comment

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

it just happens to work okay in this file, because JoinBehavior is only included within this file and `Auto-renaming columns in DataFrame` is already imported. But still, it's probably best to avoid backticks until KoDEx actually supports them

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Refactor KDoc "helpers' Remove links to deprecates access API from general kdocs

2 participants