Skip to content

Update kdoc of castTo #1318

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update kdoc of castTo #1318

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/cast.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@ public inline fun <reified T> AnyFrame.castTo(
): DataFrame<T> = cast<T>(verify = verify)

/**
* With the compiler plugin, schema marker T of DataFrame can be a local type.
* You cannot refer to it directly from your code, like a type argument for cast.
* The example below shows a situation where you'd need to cast DataFrame<*> to DataFrame<plugin generated local type>.
* With the compiler plugin, schema marker `T` of `DataFrame` can be a local type.
Copy link
Collaborator

Choose a reason for hiding this comment

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

[DataFrame]

Copy link
Collaborator

Choose a reason for hiding this comment

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

It's not only with compiler plugin, but also in Notebooks https://blog.jetbrains.com/kotlin/2024/08/track-and-analyze-github-star-growth-with-kandy-and-kotlin-dataframe/#create-a-dataframe-for-cumulative-star-count-analysis

* You cannot refer to it directly from your code, like making it a type argument for `cast`.
Copy link
Collaborator

Choose a reason for hiding this comment

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

[cast]

* The example below shows a situation where you'd need to cast `DataFrame<*>` to `DataFrame<plugin generated local type>`.
* This function helps by inferring type from [schemaFrom]
* ```
*
Expand Down