Continuing format docs for the website, using new sample dataframes in the tests module. Updated references to format

Author: Jolanrensen

core/README.md

@@ -18,7 +18,7 @@ and [tests/.../samples/api](../tests/src/test/kotlin/org/jetbrains/kotlinx/dataf
 and they are copied over to Markdown files in [docs/StardustDocs/topics](../docs/StardustDocs/topics)
 by [Korro](https://github.com/devcrocod/korro).
 
-### Explainer dataframes
+### ~~Explainer dataframes~~ NOTE: This is being moved to [tests](../tests)
 
 Aside from code samples, `@TransformDataFrameExpressions` annotated test functions also generate sample
 dataframe HTML files that can be used as iFrames on the documentation website.

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/Modify.kt

@@ -1309,38 +1309,4 @@ class Modify : TestBase() {
         }
         // SampleEnd
     }
-
-    @Test
-    fun formatExample_properties() {
-        // SampleStart
-        df
-            .format().with { bold and textColor(black) }
-            .format { isHappy }.with { background(if (it) green else red) }
-            .format { weight }.notNull().linearBg(50 to FormattingDsl.blue, 90 to FormattingDsl.red)
-            .format { age }.perRowCol { row, col ->
-                textColor(
-                    linear(value = col[row], from = col.min() to blue, to = col.max() to green)
-                )
-            }
-            .toStandaloneHtml()
-        // SampleEnd
-    }
-
-    @Suppress("UNCHECKED_CAST")
-    @Test
-    fun formatExample_strings() {
-        // SampleStart
-        df
-            .format().with { bold and textColor(black) }
-            .format("isHappy").with { background(if (it as Boolean) green else red) }
-            .format("weight").notNull().with { linearBg(it as Int, 50 to blue, 90 to red) }
-            .format("age").perRowCol { row, col ->
-                col as DataColumn<Int>
-                textColor(
-                    linear(value = col[row], from = col.min() to blue, to = col.max() to green)
-                )
-            }
-            .toStandaloneHtml()
-        // SampleEnd
-    }
 }

core/src/test/kotlin/org/jetbrains/kotlinx/dataframe/samples/api/OtherSamples.kt

@@ -2,19 +2,18 @@ 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.*
-import org.jetbrains.kotlinx.dataframe.api.FormattedFrame
 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.DisplayConfiguration
 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
+
+@Deprecated("This can now be reproduced with 'sample dataframes' in the 'tests' module.")
 class OtherSamples : TestBase() {
 
     @Test
@@ -23,33 +22,9 @@ class OtherSamples : TestBase() {
         // writeTable(df, "exampleName")
     }
 
-    @Test
-    fun formatExample() {
-        val formattedDf = df
-            .format().with { bold and textColor(black) }
-            .format { isHappy }.with { background(if (it) green else red) }
-            .format { weight }.notNull().linearBg(50 to FormattingDsl.blue, 90 to FormattingDsl.red)
-            .format { age }.perRowCol { row, col ->
-                textColor(
-                    linear(value = col[row], from = col.min() to blue, to = col.max() to green),
-                )
-            }
-
-        writeTable(formattedDf, "formatExample")
-    }
-
     private fun writeTable(df: AnyFrame, name: String) {
         val dir = File("../docs/StardustDocs/resources/snippets/manual").also { it.mkdirs() }
         val html = df.toStandaloneHtml(getFooter = WritersideFooter) + WritersideStyle
         html.writeHtml(File(dir, "$name.html"))
     }
-
-    private fun writeTable(formattedDf: FormattedFrame<*>, name: String) {
-        val dir = File("../docs/StardustDocs/resources/snippets/manual").also { it.mkdirs() }
-        val html = formattedDf.df.toStandaloneHtml(
-            configuration = formattedDf.getDisplayConfiguration(DisplayConfiguration.DEFAULT),
-            getFooter = WritersideFooter,
-        ) + WritersideStyle
-        html.writeHtml(File(dir, "$name.html"))
-    }
 }