|
1 | 1 | ## :samples
|
2 | 2 |
|
3 |
| -Code samples as well as DataFrame iframes and Kandy plot images for the |
| 3 | +Code samples, as well as DataFrame iframes and Kandy plot images, for the |
4 | 4 | [documentation website](https://github.com/Kotlin/dataframe).
|
5 | 5 |
|
6 | 6 | ### Korro
|
7 | 7 |
|
8 | 8 | Saves code samples using [Korro](https://github.com/devcrocod/korro).
|
9 | 9 |
|
10 |
| -To save / update samples: |
11 |
| -* Run `korroClean` and `korro` gradle tasks. |
| 10 | +To save or update samples: |
| 11 | +* Run the `korroClean` and `korro` Gradle tasks. |
12 | 12 |
|
13 |
| -**Important**: may work incorrectly until |
14 |
| -[migration from `:core` is not finished](https://github.com/Kotlin/dataframe/issues/898). |
15 |
| -Run Korro tasks **for the whole project**. |
| 13 | +**Important**: May not work correctly until the |
| 14 | +[migration from `:core` is finished](https://github.com/Kotlin/dataframe/issues/898). |
| 15 | +Run Korro tasks for the whole project. |
16 | 16 |
|
17 | 17 | ### SampleHelper
|
18 | 18 |
|
19 | 19 | [`SampleHelper`](https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md)
|
20 |
| -allows to save resulting Kandy plots as SVG images and `DataFrame`s as iframes. |
| 20 | +allows you to save the resulting Kandy plots as SVG images and DataFrames as iframes. |
21 | 21 |
|
22 | 22 | Running tests in this module will save or update these samples.
|
23 | 23 |
|
24 |
| -**Important**: |
| 24 | +**Important**: |
25 | 25 |
|
26 |
| -1) if the sample is changed, check if it is (так и надо было или нет короче переформулируй). |
27 |
| -You can track it with the help of the git file changes tracker in IDEA. |
28 |
| -2) All iframes should be added as resources in [this file](../docs/StardustDocs/topics/_shadow_resources.md). |
| 26 | +1) If a sample has changed, verify that the change is intentional and correct. |
| 27 | +You can track it with the Git file changes tracker in IDEA. |
| 28 | +2) Add all iframes as resources in [this file](../docs/StardustDocs/topics/_shadow_resources.md). |
29 | 29 | Run [this script](https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md#how-to-use)
|
30 | 30 | to update them.
|
31 | 31 |
|
32 | 32 | ### Notebook-To-Doc
|
33 | 33 |
|
34 |
| -Kotlin notebook can be easily converted to a documentation using |
| 34 | +A Kotlin notebook can be easily converted to documentation using |
35 | 35 | [this script](https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md#how-to-use).
|
36 |
| -It produces two files: `.kt` and `.md`. |
37 |
| -* Place `.kt` file in the tests in this module, and run it. |
38 |
| -* Place `.md` file in the [docs topics directory](../docs/StardustDocs/topics). |
39 |
| -* Run Korro tasks. |
| 36 | +It produces two files: `.kt` and `.md`. |
| 37 | +* Place the `.kt` file in the tests of this module and run it. |
| 38 | +* Place the `.md` file in the [docs topics directory](../docs/StardustDocs/topics). |
| 39 | +* Run the Korro tasks. |
0 commit comments