Skip to content

Commit f398edf

Browse files
update readme grammatics
1 parent ed1753d commit f398edf

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

samples/README.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,39 @@
11
## :samples
22

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
44
[documentation website](https://github.com/Kotlin/dataframe).
55

66
### Korro
77

88
Saves code samples using [Korro](https://github.com/devcrocod/korro).
99

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.
1212

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.
1616

1717
### SampleHelper
1818

1919
[`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.
2121

2222
Running tests in this module will save or update these samples.
2323

24-
**Important**:
24+
**Important**:
2525

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).
2929
Run [this script](https://github.com/Kotlin/kandy/blob/samples_util/util/kandy-samples-utils/README.md#how-to-use)
3030
to update them.
3131

3232
### Notebook-To-Doc
3333

34-
Kotlin notebook can be easily converted to a documentation using
34+
A Kotlin notebook can be easily converted to documentation using
3535
[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

Comments
 (0)