Skip to content

Commit 82a4437

Browse files
committed
Flatten navigation of Modify operations
The core idea is to embed all meta-information about "related" or "opposite" operations on the pages, so navigation can be simple and sorted #1292
1 parent b8e90f8 commit 82a4437

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+265
-73
lines changed

docs/StardustDocs/d.tree

Lines changed: 43 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -91,73 +91,50 @@
9191
</toc-element>
9292
</toc-element>
9393
<toc-element topic="modify.md">
94-
<toc-element topic="sliceRows.md">
95-
<toc-element topic="xs.md"/>
96-
</toc-element>
94+
<toc-element topic="add.md"/>
95+
<toc-element topic="adjustSchema.md"/>
96+
<toc-element topic="append.md"/>
97+
<toc-element topic="cast.md"/>
98+
<toc-element topic="concat.md"/>
99+
<toc-element topic="convert.md"/>
100+
<toc-element topic="convertTo.md"/>
101+
<toc-element topic="distinct.md"/>
102+
<toc-element topic="drop.md"/>
103+
<toc-element topic="duplicate.md"/>
104+
<toc-element topic="explode.md"/>
105+
<toc-element topic="fill.md"/>
106+
<toc-element topic="filter.md"/>
107+
<toc-element topic="filterRows.md"/>
108+
<toc-element topic="flatten.md"/>
109+
<toc-element topic="gather.md"/>
110+
<toc-element topic="group.md"/>
111+
<toc-element topic="groupBy.md"/>
112+
<toc-element topic="implode.md"/>
113+
<toc-element topic="inferType.md"/>
114+
<toc-element topic="insert.md"/>
115+
<toc-element topic="join.md"/>
116+
<toc-element topic="joinWith.md"/>
117+
<toc-element topic="map.md"/>
118+
<toc-element topic="merge.md"/>
119+
<toc-element topic="move.md"/>
120+
<toc-element topic="parse.md"/>
121+
<toc-element topic="pivot.md"/>
122+
<toc-element topic="remove.md"/>
123+
<toc-element topic="rename.md"/>
124+
<toc-element topic="reorder.md"/>
125+
<toc-element topic="reorderRows.md"/>
126+
<toc-element topic="replace.md"/>
127+
<toc-element topic="reverse.md"/>
97128
<toc-element topic="select.md"/>
98-
<toc-element topic="filterRows.md">
99-
<toc-element topic="filter.md"/>
100-
<toc-element topic="drop.md"/>
101-
<toc-element topic="distinct.md"/>
102-
</toc-element>
103-
<toc-element topic="reorderRows.md">
104-
<toc-element topic="sortBy.md"/>
105-
<toc-element topic="shuffle.md"/>
106-
<toc-element topic="reverse.md"/>
107-
</toc-element>
108-
<toc-element topic="groupByConcat.md">
109-
<toc-element topic="groupBy.md"/>
110-
<toc-element topic="concat.md"/>
111-
</toc-element>
112-
<toc-element topic="updateConvert.md">
113-
<toc-element topic="update.md">
114-
<toc-element topic="fill.md"/>
115-
</toc-element>
116-
<toc-element topic="convert.md">
117-
<toc-element topic="parse.md"/>
118-
<toc-element topic="unfold.md"/>
119-
</toc-element>
120-
<toc-element topic="inferType.md"/>
121-
</toc-element>
122-
<toc-element topic="splitMerge.md">
123-
<toc-element topic="split.md"/>
124-
<toc-element topic="merge.md"/>
125-
</toc-element>
126-
<toc-element topic="addRemove.md">
127-
<toc-element topic="add.md"/>
128-
<toc-element topic="map.md"/>
129-
<toc-element topic="remove.md"/>
130-
</toc-element>
131-
<toc-element topic="moveRename.md">
132-
<toc-element topic="move.md"/>
133-
<toc-element topic="rename.md"/>
134-
<toc-element topic="reorder.md"/>
135-
</toc-element>
136-
<toc-element topic="groupUngroupFlatten.md">
137-
<toc-element topic="group.md"/>
138-
<toc-element topic="ungroup.md"/>
139-
<toc-element topic="flatten.md"/>
140-
</toc-element>
141-
<toc-element topic="insertReplace.md">
142-
<toc-element topic="insert.md"/>
143-
<toc-element topic="replace.md"/>
144-
</toc-element>
145-
<toc-element topic="explodeImplode.md">
146-
<toc-element topic="explode.md"/>
147-
<toc-element topic="implode.md"/>
148-
</toc-element>
149-
<toc-element topic="pivotGather.md">
150-
<toc-element topic="pivot.md"/>
151-
<toc-element topic="gather.md"/>
152-
</toc-element>
153-
<toc-element topic="appendDuplicate.md">
154-
<toc-element topic="append.md"/>
155-
<toc-element topic="duplicate.md"/>
156-
</toc-element>
157-
<toc-element topic="adjustSchema.md">
158-
<toc-element topic="cast.md"/>
159-
<toc-element topic="convertTo.md"/>
160-
</toc-element>
129+
<toc-element topic="shuffle.md"/>
130+
<toc-element topic="sliceRows.md"/>
131+
<toc-element topic="sortBy.md"/>
132+
<toc-element topic="split.md"/>
133+
<toc-element topic="toList.md"/>
134+
<toc-element topic="unfold.md"/>
135+
<toc-element topic="ungroup.md"/>
136+
<toc-element topic="update.md"/>
137+
<toc-element topic="xs.md"/>
161138
</toc-element>
162139
<toc-element toc-title="Statistics">
163140
<toc-element topic="summaryStatistics.md">

docs/StardustDocs/topics/add.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ Original [`DataFrame`](DataFrame.md) is not modified.
88
`add` appends columns to the end of the dataframe by default.
99
If you want to add a single column to a specific position in the dataframe, use [insert](insert.md).
1010

11+
Related operations: [remove](remove.md), [map](map.md)
12+
1113
## Create a new column and add it to [`DataFrame`](DataFrame.md)
1214

1315
```text

docs/StardustDocs/topics/append.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,6 @@ df.append (
77
"John", 17,
88
"Bill", 30)
99
```
10+
11+
12+
Related operations: [duplicate](duplicate.md)

docs/StardustDocs/topics/cast.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,3 +60,6 @@ for (file in files) {
6060
```
6161

6262
<!---END-->
63+
64+
65+
Related operations: [convertTo](convertTo.md)

docs/StardustDocs/topics/concat.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,8 @@ frameColumn.concat()
9393

9494
If you want to take the union of columns (not rows) from several [`DataFrame`](DataFrame.md) objects, see [`add`](add.md).
9595

96+
Related operations: [join](join.md)
97+
9698
## Schema unification
9799

98100
If input [`DataFrame`](DataFrame.md) objects have different schemas, every column in the resulting [`DataFrame`](DataFrame.md)

docs/StardustDocs/topics/convert.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,3 +116,6 @@ dataFrameOf("value")("1", "2") // note that values are strings; conversion is do
116116

117117
<inline-frame src="resources/org.jetbrains.kotlinx.dataframe.samples.api.Modify.convertToValueClass.html" width="100%"/>
118118
<!---END-->
119+
120+
121+
Related operations: [update](update.md), [parse](parse.md), [unfold](unfold.md)

docs/StardustDocs/topics/convertTo.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,3 +34,6 @@ df.convertTo<MySchema> {
3434
```
3535

3636
<!---END-->
37+
38+
39+
Related operations: [cast](cast.md)

docs/StardustDocs/topics/count.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,3 +35,6 @@ df.pivot { name.firstName }.groupBy { name.lastName }.count()
3535

3636
<inline-frame src="resources/org.jetbrains.kotlinx.dataframe.samples.api.Analyze.countAggregation.html" width="100%"/>
3737
<!---END-->
38+
39+
40+
Related operations: [countDistinct](countDistinct.md), [valueCounts](valueCounts.md)

docs/StardustDocs/topics/countDistinct.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,6 @@ df.countDistinct()
3131
```
3232

3333
<!---END-->
34+
35+
36+
Related operations: [count](count.md), [valueCounts](valueCounts.md)

docs/StardustDocs/topics/cumSum.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,3 +30,6 @@ df.groupBy { city }.cumSum { weight }.concat()
3030
```
3131

3232
<!---END-->
33+
34+
35+
Related operations: [sum](sum.md)

0 commit comments

Comments
 (0)