updated kdocs of format with information about colgroups and framecols

Jolanrensen · Jolanrensen · commit 37ecc695439b · 2025-08-12T16:45:10.000+02:00
diff --git a/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/format.kt b/core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/format.kt
@@ -14,8 +14,10 @@ import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.linear
 import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.linearBg
 import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.rgb
 import org.jetbrains.kotlinx.dataframe.api.FormattingDsl.textColor
+import org.jetbrains.kotlinx.dataframe.columns.ColumnGroup
 import org.jetbrains.kotlinx.dataframe.columns.ColumnReference
 import org.jetbrains.kotlinx.dataframe.columns.ColumnWithPath
+import org.jetbrains.kotlinx.dataframe.columns.FrameColumn
 import org.jetbrains.kotlinx.dataframe.columns.toColumnSet
 import org.jetbrains.kotlinx.dataframe.dataTypes.IFRAME
 import org.jetbrains.kotlinx.dataframe.dataTypes.IMG
@@ -66,9 +68,21 @@ import kotlin.reflect.KProperty
  *
  * You can continue formatting the [FormattedFrame] by calling [format][FormattedFrame.format] on it again.
  *
+ * Specifying a [column group][ColumnGroup] makes all of its inner columns be formatted in the same way unless
+ * overridden.
+ *
  * Formatting is done additively, meaning you can add more formatting to a cell that's already formatted or
  * override certain attributes inherited from its outer group.
  *
+ * Specifying a [frame column][FrameColumn] at the moment does nothing
+ * ([Issue #1375](https://github.com/Kotlin/dataframe/issues/1375)),
+ * convert each nested [DataFrame] to a [FormattedFrame] instead:
+ * ```kt
+ * df.convert { myFrameCol }.with {
+ *     it.format { someCol }.with { background(green) }
+ * }.toStandaloneHtml()
+ * ```
+ *
  * Check out the [Grammar].
  *
  * For more information: {@include [DocumentationUrls.Format]}
diff --git a/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.FormatDocs.Grammar.ForHtml.html b/docs/StardustDocs/resources/snippets/kdocs/org.jetbrains.kotlinx.dataframe.api.FormatDocs.Grammar.ForHtml.html
@@ -85,7 +85,7 @@
     window.addEventListener('resize', sendHeight);
 </script>
 </head>
-<body><h3>Definitions:</h3><p><code>cellFormatter: </code><code>FormattingDsl</code><code>.(cell: C) -&gt; </code><code>CellAttributes</code><code>?</code></p><p>    </p><p><code>rowColFormatter: </code><code>FormattingDsl</code><code>.(row: </code><code>DataRow</code><code>&lt;T&gt;, col: </code><code>DataColumn</code><code>&lt;C&gt;) -&gt; </code><code>CellAttributes</code><code>?</code></p><h3>Notation:</h3><p><code><strong>format</strong></code><strong><code> { </code></strong><code><code>columns</code></code><strong><code> }</code></strong></p><p>    
+<body><h3>Definitions:</h3><p><code>cellFormatter: </code><code>FormattingDsl</code><code>.(cell: C) -&gt; </code><code>CellAttributes</code><code>?</code></p><p>    </p><p><code>rowColFormatter: </code><code>FormattingDsl</code><code>.(row: </code><code>DataRow</code><code>&lt;T&gt;, col: </code><code>ColumnWithPath</code><code>&lt;C&gt;) -&gt; </code><code>CellAttributes</code><code>?</code></p><h3>Notation:</h3><p><code><strong>format</strong></code><strong><code> { </code></strong><code><code>columns</code></code><strong><code> }</code></strong></p><p>    
 <code>[ </code><strong><code>.</code></strong><code><strong><code>where</code></strong></code><strong><code> { </code></strong><code><code>filter</code></code><code>: </code><code><code>RowValueFilter</code></code><strong><code> } </code></strong><code>]</code></p><p>    
 <code>[ </code><strong><code>.</code></strong><code><strong><code>at</code></strong></code><strong><code>(</code></strong><code>rowIndices: </code><code>Collection</code><code>&lt;</code><code>Int</code><code>&gt; | </code><code>IntRange</code><code>|</code><strong><code>vararg</code></strong><code> </code><code>Int</code><strong><code>)</code></strong><code> ]</code></p><p>    
 <code>[ </code><strong><code>.</code></strong><code><strong><code>notNull</code></strong></code><strong><code>()</code></strong><code> ]</code></p><p>    
