Skip to content

Commit 3e9f7a7

Browse files
formatHeader KDocs fix
1 parent 967f611 commit 3e9f7a7

File tree

1 file changed

+5
-4
lines changed

1 file changed

+5
-4
lines changed

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/formatHeader.kt

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ import org.jetbrains.kotlinx.dataframe.impl.getColumnPaths
1313
* A lambda used to format a column header (its displayed name) when rendering a dataframe to HTML.
1414
*
1515
* The lambda runs in the context of [FormattingDsl] and receives the [ColumnWithPath] of the header to format.
16-
* Return a [CellAttributes] (or `null`) describing CSS you want to apply to the header cell.
16+
* Return a [CellAttributes] (or `null`) describing the CSS you want to apply to the header cell.
1717
*
1818
* Examples:
19-
* - Center a header: `attr("text-align", "center")`
19+
* - Center the header: `attr("text-align", "center")`
2020
* - Make it bold: `bold`
21-
* - Set custom color: `textColor(rgb(10, 10, 10))`
21+
* - Set a custom color: `textColor(rgb(10, 10, 10))`
2222
*/
2323
public typealias HeaderColFormatter<C> = FormattingDsl.(col: ColumnWithPath<C>) -> CellAttributes?
2424

@@ -133,7 +133,8 @@ public fun <T> FormattedFrame<T>.formatHeader(): HeaderFormatClause<T, Any?> =
133133
* Creates a new [FormattedFrame] that uses the specified [HeaderColFormatter] to format the selected headers.
134134
*
135135
* Header formatting is additive: attributes from already-applied header formatters are combined with the newly
136-
* returned attributes using [CellAttributes.and]. If a parent column group is selected, its attributes are
136+
*
137+
* returned attributes using [CellAttributes.and]. If a parent column group is selected, its attributes are
137138
* applied to its children unless explicitly overridden.
138139
*/
139140
@Suppress("UNCHECKED_CAST")

0 commit comments

Comments
 (0)