Skip to content
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

Jump to bottom

Changed documentation regarding extension properties api #651

Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Changed documentation regarding extension properties api #651

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
40a8064
more explicit explanation of what happens in between cell calls in th…
Jolanrensen Apr 6, 2024
0d20297
wip
Jolanrensen Apr 30, 2024
2334dcd
Merge branch 'refs/heads/master' into docs-fixes
Jolanrensen May 15, 2024
c8cb507
added example df to extensionPropertiesApi.md
Jolanrensen May 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...erated-sources/src/main/kotlin/org/jetbrains/kotlinx/dataframe/documentation/AccessApi.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,7 +122,7 @@ internal interface AccessApi {
*
* For example:
* ```kotlin
* val df = DataFrame.read("titanic.csv")
* val df /* : AnyFrame */ = DataFrame.read("titanic.csv")
* ```
*/
interface ExtensionPropertiesApi
Expand Down
2 changes: 1 addition & 1 deletion ...enerated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/ApiLevels.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ class ApiLevels {
@TransformDataFrameExpressions
fun extensionProperties1() {
// SampleStart
val df = DataFrame.read("titanic.csv")
val df /* : AnyFrame */ = DataFrame.read("titanic.csv")
// SampleEnd
}
}
6 changes: 5 additions & 1 deletion ...rated-sources/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/OtherSamples.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
package org.jetbrains.kotlinx.dataframe.samples.api

import org.jetbrains.kotlinx.dataframe.AnyFrame
import org.jetbrains.kotlinx.dataframe.DataFrame
import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
import org.jetbrains.kotlinx.dataframe.api.take
import org.jetbrains.kotlinx.dataframe.explainer.WritersideFooter
import org.jetbrains.kotlinx.dataframe.explainer.WritersideStyle
import org.jetbrains.kotlinx.dataframe.io.read
import org.jetbrains.kotlinx.dataframe.io.toStandaloneHTML
import org.junit.Test
import java.io.File

// To display code together with a table, we can use TransformDataFrameExpressions annotation together with korro
// This class provides an ability to save only a table that can be embedded anywhere in the documentation
class OtherSamples {

@Test
fun extensionPropertiesApi1() {
val df = dataFrameOf("example")(123)
val df = DataFrame.read("../data/titanic.csv", delimiter = ';').take(5)
writeTable(df, "extensionPropertiesApi1")
}

Expand Down
2 changes: 1 addition & 1 deletion core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/ApiLevels.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ class ApiLevels {
@TransformDataFrameExpressions
fun extensionProperties1() {
// SampleStart
val df = DataFrame.read("titanic.csv")
val df /* : AnyFrame */ = DataFrame.read("titanic.csv")
// SampleEnd
}
}
6 changes: 5 additions & 1 deletion core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/OtherSamples.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
package org.jetbrains.kotlinx.dataframe.samples.api

import org.jetbrains.kotlinx.dataframe.AnyFrame
import org.jetbrains.kotlinx.dataframe.DataFrame
import org.jetbrains.kotlinx.dataframe.api.dataFrameOf
import org.jetbrains.kotlinx.dataframe.api.take
import org.jetbrains.kotlinx.dataframe.explainer.WritersideFooter
import org.jetbrains.kotlinx.dataframe.explainer.WritersideStyle
import org.jetbrains.kotlinx.dataframe.io.read
import org.jetbrains.kotlinx.dataframe.io.toStandaloneHTML
import org.junit.Test
import java.io.File

// To display code together with a table, we can use TransformDataFrameExpressions annotation together with korro
// This class provides an ability to save only a table that can be embedded anywhere in the documentation
class OtherSamples {

@Test
fun extensionPropertiesApi1() {
val df = dataFrameOf("example")(123)
val df = DataFrame.read("../data/titanic.csv", delimiter = ';').take(5)
writeTable(df, "extensionPropertiesApi1")
}

Expand Down