Skip to content

Commit 55fb5de

Browse files
docs fixes
1 parent e3d0e01 commit 55fb5de

File tree

10 files changed

+23
-16
lines changed

10 files changed

+23
-16
lines changed

docs/StardustDocs/topics/collectionsInterop/associate.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# associate
22

33
<web-summary>
4-
Discover `associate` interop for Kotlin DataFrame.
4+
Discover `associate` operation for Kotlin DataFrame.
55
</web-summary>
66

77
<card-summary>
8-
Discover `associate` interop for Kotlin DataFrame.
8+
Discover `associate` operation for Kotlin DataFrame.
99
</card-summary>
1010

1111
<link-summary>
12-
Discover `associate` interop for Kotlin DataFrame.
12+
Discover `associate` operation for Kotlin DataFrame.
1313
</link-summary>
1414

1515
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.collectionsInterop.AssociateSamples-->
@@ -23,7 +23,7 @@ If multiple rows produce the same key, only the last value for that key is kept.
2323
```kotlin
2424
df.associate { pairSelector }
2525

26-
pairSelector := (DataRow) -> Pair
26+
pairSelector: (DataRow) -> Pair
2727
```
2828

2929
### Related functions

docs/StardustDocs/topics/collectionsInterop/associateBy.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# associateBy
22

33
<web-summary>
4-
Discover `associateBy` interop for Kotlin DataFrame.
4+
Discover `associateBy` operation for Kotlin DataFrame.
55
</web-summary>
66

77
<card-summary>
8-
Discover `associateBy` interop for Kotlin DataFrame.
8+
Discover `associateBy` operation for Kotlin DataFrame.
99
</card-summary>
1010

1111
<link-summary>
12-
Discover `associateBy` interop for Kotlin DataFrame.
12+
Discover `associateBy` operation for Kotlin DataFrame.
1313
</link-summary>
1414

1515
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.collectionsInterop.AssociateBySamples-->
@@ -26,7 +26,7 @@ function.
2626
```kotlin
2727
df.associateBy { keySelector }
2828

29-
keySelector := (DataRow) -> Key
29+
keySelector: (DataRow) -> Key
3030
```
3131

3232
### Related functions

docs/StardustDocs/topics/info/tail.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,14 +15,17 @@ Discover `tail` operation in Kotlin Dataframe.
1515

1616
<!---IMPORT org.jetbrains.kotlinx.dataframe.samples.api.info.TailSamples-->
1717

18-
Returns a [`DataFrame`](DataFrame.md) with the last `numRows` rows.
18+
Returns a [`DataFrame`](DataFrame.md) with the last five rows.
1919

20-
This is equivalent to calling [`takeLast`](sliceRows.md#takelast) with the same argument. By default, `numRows = 5`.
20+
This is equivalent to calling [`takeLast`](sliceRows.md#takelast) with the same `numRows` argument.
21+
By default, `numRows = 5`.
2122

2223
```kotlin
23-
df.tail(numRows: Int)
24+
df.tail(numRows: Int = 5)
2425
```
2526

27+
**Related operations**: [`head`](head.md), [`takeLast`](sliceRows.md#takelast), [`take`](sliceRows.md#take).
28+
2629
### Examples
2730

2831
<!---FUN notebook_test_tail_1-->

docs/StardustDocs/topics/operations/column/asIterable.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ Returns values of this [`DataColumn`](DataColumn.md) as
2020
```kotlin
2121
col.asIterable()
2222
```
23+
24+
**Related operation**: [](asSequenceColumn.md).

docs/StardustDocs/topics/operations/column/asSequenceColumn.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,5 @@ Returns values of this [`DataColumn`](DataColumn.md) as
2020
```kotlin
2121
col.asSequence()
2222
```
23+
24+
**Related operation**: [](asIterable.md).

docs/StardustDocs/topics/operations/column/between.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ df.age.between(left = 18, right = 25)
4545
<!---END-->
4646
<inline-frame src="./resources/notebook_test_between_2.html" width="100%" height="500px"></inline-frame>
4747

48-
Strictly between 18 and 25 (exclude boundaries):
48+
Strictly between 18 and 25 (excluding boundaries):
4949
<!---FUN notebook_test_between_3-->
5050

5151
```kotlin

docs/StardustDocs/topics/operations/utils/all.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Returns `Boolean` — `true` if every row satisfies the predicate, `false` other
2222
```kotlin
2323
all { rowCondition }
2424

25-
rowCondition := (DataRow) -> Boolean
25+
rowCondition: (DataRow) -> Boolean
2626
```
2727

2828
**Related operations**: [](any.md), [](filter.md), [](single.md), [](count.md).

docs/StardustDocs/topics/operations/utils/any.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Returns `Boolean` — `true` if there is at least one row that satisfies the pre
2222
```kotlin
2323
df.any { rowCondition }
2424

25-
rowCondition := (DataRow) -> Boolean
25+
rowCondition: (DataRow) -> Boolean
2626
```
2727

2828
**Related operations**: [](all.md), [](filter.md), [](single.md), [](count.md).

docs/StardustDocs/topics/operations/utils/chunked.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Splits a [`DataFrame`](DataFrame.md) into consecutive sub-dataframes (chunks) an
1919
[`FrameColumn`](DataColumn.md#framecolumn). Chunks are formed in order and do not overlap.
2020

2121
Each chunk contains at most the specified number of rows.
22-
The resulting FrameColumn’s name can be customized; by default, it is "groups."
22+
The resulting `FrameColumn`’s name can be customized; by default, it is "groups."
2323

2424
`DataFrame` can be split into chunks in two ways:
2525
- By fixed size: split into chunks of up to the given size.

docs/StardustDocs/topics/operations/utils/shuffle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Discover `shuffle` operation in Kotlin Dataframe.
1818
Returns a new [`DataFrame`](DataFrame.md) with rows in random order.
1919

2020
You can supply a [kotlin.random.Random](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.random/-random/)
21-
instance for reproducible results.
21+
instance with a fixed seed for reproducible results.
2222

2323
```Kotlin
2424
df.shuffle()

0 commit comments

Comments
 (0)