Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extracted subchapters #391

Merged
merged 3 commits into from
Jun 8, 2023
Merged

Extracted subchapters #391

merged 3 commits into from
Jun 8, 2023

Conversation

zaleslaw
Copy link
Collaborator

@zaleslaw zaleslaw commented Jun 8, 2023

Fixed #268
No huge changes, just restructured some tutorials

@zaleslaw zaleslaw merged commit db85e02 into Kotlin:master Jun 8, 2023
1 check passed
1. Columns in `df` are analyzed to extract data schema
2. Empty interface with [`DataSchema`](schema.md) annotation is generated:
* [**Custom Data Schemas**](schemasCustom.md) <br/>
Sometimes it is necessary to create your own scheme.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*schema

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, but we call it "schema" everywhere else. Also "scheme" means something different than "schema". A scheme is a plan, an idea. A schema is a written down or drawn-out idea. So schema is rightfully used across the docs.

interface DataFrameType
```
* [**Use external Data Schemas in Jupyter**](schemasExternalJupyter.md) <br/>
Sometimes it is convenient to extract reusable code from Jupyter Notebook into the Kotlin JVM library.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

*a Kotiln JVM library

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All grammar checkers including Grammarly and Grazie put here the

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, but they don't know the context and concepts. They don't know whether there are one or multiple Kotlin JVM libraries.

```
* [**Use external Data Schemas in Jupyter**](schemasExternalJupyter.md) <br/>
Sometimes it is convenient to extract reusable code from Jupyter Notebook into the Kotlin JVM library.
Schema interfaces should also be extracted if this code uses Custom Data Schemas.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

custom should not have a capital C

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, probably all the words should be or not should be capitalized

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

custom data schemas

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

agreed :)

@Jolanrensen
Copy link
Collaborator

Please don't just merge new documentation without letting someone else do a spellcheck. The documentation is already filled with unclear sentences and inconsistencies because of the language barrier, but we can at least make sure that changes to it make it better :)

@zaleslaw
Copy link
Collaborator Author

zaleslaw commented Jun 9, 2023

The problem is the following: I'm using Grazie and Grammarly for the final spellchecking phase of my writing. But some stuff could be missed. If you are ready, review all my documentation changes; I will be happy to double-check here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Refactor the page tree for the bunch of pages related to Schema support
2 participants