Skip to content

Commit 40ed8c0

Browse files
JolanrensenJolanrensen
authored
Merge pull request #1238 from Kotlin/small-docs-fixes
various docs fixes to lower the number of errors
2 parents d60022c + f3f6931 commit 40ed8c0

File tree

9 files changed

+95
-42
lines changed

9 files changed

+95
-42
lines changed

‎docs/StardustDocs/topics/ColumnSelectors.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,17 +49,17 @@ or `ColumnSet` that adheres to the optional given condition. If no column adhere
4949
`NoSuchElementException` is thrown.
5050

5151
##### Col {collapsible="true"}
52-
`col(name)`, `col(5)`, `this[5]`
52+
`col(name)`, `col(5)`
5353

54-
Creates a [ColumnAccessor](DataColumn.md#column-accessors) (or `SingleColumn`) for a column with the given
54+
Creates a [ColumnAccessor](DataColumn.md) (or `SingleColumn`) for a column with the given
5555
argument from the top-level or specified [column group](DataColumn.md#columngroup). The argument can be either an
5656
index (`Int`) or a reference to a column (`String`, `ColumnPath`, `KProperty`, or `ColumnAccessor`;
5757
any [AccessApi](apiLevels.md)).
5858

5959
##### Value Col, Frame Col, Col Group {collapsible="true"}
6060
`valueCol(name)`, `valueCol(5)`, `frameCol(name)`, `frameCol(5)`, `colGroup(name)`, `colGroup(5)`
6161

62-
Creates a [ColumnAccessor](DataColumn.md#column-accessors) (or `SingleColumn`) for a
62+
Creates a [ColumnAccessor](DataColumn.md) (or `SingleColumn`) for a
6363
[value column](DataColumn.md#valuecolumn) / [frame column](DataColumn.md#framecolumn) /
6464
[column group](DataColumn.md#columngroup) with the given argument from the top-level or
6565
specified [column group](DataColumn.md#columngroup). The argument can be either an index (`Int`) or a reference

‎docs/StardustDocs/topics/Compiler-Plugin.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,9 @@
33
Kotlin DataFrame compiler plugin: available in Gradle projects, is coming to Kotlin Notebook and Maven projects soon.
44

55
Check out this video that shows how expressions update the schema of a dataframe:
6-
<video src="compiler_plugin.mp4" controls/>
6+
7+
8+
<video src="compiler_plugin.mp4" controls=""/>
79

810
## Setup
911

‎docs/StardustDocs/topics/_shadow_resources.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -164,4 +164,4 @@
164164
<resource src="notebook_test_generate_docs_1.html"></resource>
165165
<resource src="notebook_test_rename_3.html"></resource>
166166
<resource src="notebook_test_rename_4.html"></resource>
167-
<resource src="notebook_test_rename_5.html"></resource>
167+
<resource src="notebook_test_rename_5.html"></resource>

‎docs/StardustDocs/topics/gettingStarted/gettingStartedGradleAdvanced.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -224,7 +224,7 @@ tasks.withType(org.jmailen.gradle.kotlinter.tasks.LintTask).all {
224224
</tab>
225225
<tab title=".editorconfig">
226226

227-
```.editorconfig
227+
```editorconfig
228228
[{**/*.Generated.kt,**/*$Extensions.kt}]
229229
ktlint = disabled
230230
```

‎docs/StardustDocs/topics/guides/Kotlin-DataFrame-Features-in-Kotlin-Notebook.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Here are the key features:
2222
You can quickly load data into `DataFrame` into a notebook by simply dragging and dropping a file
2323
(.csv/.json/.xlsx and .geojson/.shp) directly into the notebook editor:
2424

25-
<video src="ktnb_drag_n_drop.mp4" controls/>
25+
<video src="ktnb_drag_n_drop.mp4" controls=""/>
2626

2727
### Visual Data Exploration
2828
**Page through your data**:
@@ -35,18 +35,26 @@ This is a convenient alternative to using `sortBy` in separate cells.
3535
**Go straight to the data you need**:
3636
You can jump directly to a particular row or column if you want something specific.
3737
This makes working with large datasets more straightforward.
38-
<video src="https://github.com/user-attachments/assets/aeae1c79-9755-4558-bac4-420bf1331f39" controls></video>
38+
39+
40+
<video src="https://github.com/user-attachments/assets/aeae1c79-9755-4558-bac4-420bf1331f39" controls=""/>
41+
3942

4043
### Drill down into nested data
4144
When your data has multiple layers, like a table within a table,
4245
you can now click on a cell containing a nested table to view these details directly.
4346
This makes it easy to go deeper into your data and then return to where you were.
44-
<video src="https://github.com/user-attachments/assets/ef9509be-e19b-469c-9bad-0ce81eec36b0" controls></video>
47+
48+
49+
<video src="https://github.com/user-attachments/assets/ef9509be-e19b-469c-9bad-0ce81eec36b0" controls=""/>
50+
4551

4652
### Visualize multiple tables via tabs
4753
You can open and visualize multiple tables in separate tabs.
4854
This feature is tailored to those who need to compare, contrast, or monitor different datasets simultaneously.
49-
<video src="https://github.com/user-attachments/assets/51b7a6e3-0187-49b3-bf5e-0c4d60f8b769" controls></video>
55+
56+
57+
<video src="https://github.com/user-attachments/assets/51b7a6e3-0187-49b3-bf5e-0c4d60f8b769" controls=""/>
5058

5159

5260
### Exporting to files
@@ -55,7 +63,9 @@ You can export data directly from the dataframe into various file formats.
5563
This simplifies sharing and further analysis.
5664
The interface supports exporting data to JSON for web applications,
5765
CSV for spreadsheet tools, and XML for data interchange.
58-
<video src="https://github.com/user-attachments/assets/ec28c59a-1555-44ce-98f6-a60d8feae347" controls></video>
66+
67+
68+
<video src="https://github.com/user-attachments/assets/ec28c59a-1555-44ce-98f6-a60d8feae347" controls=""/>
5969

6070

6171
### Convenient copying of data from tables
@@ -64,7 +74,9 @@ or you can use keyboard shortcuts for quicker selection
6474
and then copy what’s needed with a simple right-click or another shortcut.
6575
It’s designed to feel intuitive,
6676
like copying text from a document, but with the structure and format of your data preserved.
67-
<video src="https://github.com/user-attachments/assets/88e53dfb-361f-40f8-bffb-52a512cdd3cd" controls></video>
77+
78+
79+
<video src="https://github.com/user-attachments/assets/88e53dfb-361f-40f8-bffb-52a512cdd3cd" controls=""/>
6880

6981

7082
To get started, ensure you have the latest version of the Kotlin Notebook Plugin installed in IntelliJ IDEA,

‎docs/StardustDocs/topics/median.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,13 +58,13 @@ See [column selectors](ColumnSelectors.md) for how to select the columns for thi
5858
The following automatic type conversions are performed for the `median` operation.
5959
(Note that `null` only appears in the return type when using `-orNull` overloads).
6060

61-
| Conversion | Result for Empty Input |
62-
|--------------------------------|------------------------|
63-
| T -> T where T : Comparable<T> | null |
64-
| Int -> Double | null |
65-
| Byte -> Double | null |
66-
| Short -> Double | null |
67-
| Long -> Double | null |
68-
| Double -> Double | null |
69-
| Float -> Double | null |
70-
| Nothing -> Nothing | null |
61+
| Conversion | Result for Empty Input |
62+
|----------------------------------|------------------------|
63+
| T -> T where T : Comparable\<T\> | null |
64+
| Int -> Double | null |
65+
| Byte -> Double | null |
66+
| Short -> Double | null |
67+
| Long -> Double | null |
68+
| Double -> Double | null |
69+
| Float -> Double | null |
70+
| Nothing -> Nothing | null |

‎docs/StardustDocs/topics/minmax.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -49,13 +49,13 @@ See [column selectors](ColumnSelectors.md) for how to select the columns for thi
4949
The following automatic type conversions are performed for the `min` and `max` operations.
5050
(Note that `null` only appears in the return type when using `-orNull` overloads).
5151

52-
| Conversion | Result for Empty Input |
53-
|--------------------------------|------------------------|
54-
| T -> T where T : Comparable<T> | null |
55-
| Int -> Int | null |
56-
| Byte -> Byte | null |
57-
| Short -> Short | null |
58-
| Long -> Long | null |
59-
| Double -> Double | null |
60-
| Float -> Float | null |
61-
| Nothing -> Nothing | null |
52+
| Conversion | Result for Empty Input |
53+
|----------------------------------|------------------------|
54+
| T -> T where T : Comparable\<T\> | null |
55+
| Int -> Int | null |
56+
| Byte -> Byte | null |
57+
| Short -> Short | null |
58+
| Long -> Long | null |
59+
| Double -> Double | null |
60+
| Float -> Float | null |
61+
| Nothing -> Nothing | null |

‎docs/StardustDocs/topics/parse.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,3 +96,42 @@ DataFrame.parser.addDateTimePattern("dd.MM.uuuu HH:mm:ss")
9696
```
9797

9898
<!---END-->
99+
100+
For `locale`, this means that the one being used by the parser is defined as:
101+
102+
↪ The locale given as function argument directly, or in `parserOptions`, if it is not `null`, else
103+
104+
&nbsp;&nbsp;&nbsp;&nbsp;↪ The locale set by `DataFrame.parser.locale = ...`, if it is not `null`, else
105+
106+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;↪ `Locale.getDefault()`, which is the system's default locale that can be changed with `Locale.setDefault()`.
107+
108+
### Parsing Doubles
109+
110+
DataFrame has a new fast and powerful double parser enabled by default.
111+
It is based on [the FastDoubleParser library](https://github.com/wrandelshofer/FastDoubleParser) for its
112+
high performance and configurability
113+
(in the future, we might expand this support to `Float`, `BigDecimal`, and `BigInteger` as well).
114+
115+
The parser is locale-aware; it will use the locale set by the
116+
[(global)](#global-parser-options) [parser options](#parser-options) to parse the doubles.
117+
It also has a fallback mechanism built in, meaning it can recognize characters from
118+
all other locales (and some from [Wikipedia](https://en.wikipedia.org/wiki/Decimal_separator))
119+
and parse them correctly as long as they don't conflict with the current locale.
120+
121+
For example, if your locale uses ',' as decimal separator, it will not recognize ',' as thousands separator, but it will
122+
recognize ''', ' ', '٬', '_', ' ', etc. as such.
123+
The same holds for characters like "e", "inf", "×10^", "NaN", etc. (ignoring case).
124+
125+
This means you can safely parse `"123'456 789,012.345×10^6"` with a US locale but not `"1.234,5"`.
126+
127+
Aside from this, DataFrame also explicitly recognizes "∞", "inf", "infinity", and "infty" as `Double.POSITIVE_INFINITY`
128+
(as well as their negative counterparts), "nan", "na", and "n/a" as `Double.NaN`,
129+
and all forms of whitespace are treated equally.
130+
131+
If `FastDoubleParser` fails to parse a `String` as `Double`, DataFrame will try
132+
to parse it using the standard `NumberFormat.parse()` function as a last resort.
133+
134+
If you experience any issues with the new parser, you can turn it off by setting
135+
`useFastDoubleParser = false`, which will use the old `NumberFormat.parse()` function instead.
136+
137+
Please [report](https://github.com/Kotlin/dataframe/issues) any issues you encounter.

‎docs/StardustDocs/topics/percentile.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -80,13 +80,13 @@ See [column selectors](ColumnSelectors.md) for how to select the columns for thi
8080
The following automatic type conversions are performed for the `percentile` operation.
8181
(Note that `null` only appears in the return type when using `-orNull` overloads).
8282

83-
| Conversion | Result for Empty Input |
84-
|--------------------------------|------------------------|
85-
| T -> T where T : Comparable<T> | null |
86-
| Int -> Double | null |
87-
| Byte -> Double | null |
88-
| Short -> Double | null |
89-
| Long -> Double | null |
90-
| Double -> Double | null |
91-
| Float -> Double | null |
92-
| Nothing -> Nothing | null |
83+
| Conversion | Result for Empty Input |
84+
|----------------------------------|------------------------|
85+
| T -> T where T : Comparable\<T\> | null |
86+
| Int -> Double | null |
87+
| Byte -> Double | null |
88+
| Short -> Double | null |
89+
| Long -> Double | null |
90+
| Double -> Double | null |
91+
| Float -> Double | null |
92+
| Nothing -> Nothing | null |

0 commit comments

Comments
 (0)