Documentation updates #560
Conversation
koperagen
force-pushed
the
documentation-updates
branch
from
2e9a396
to
e549f8b
Compare
There was a problem hiding this comment.
Overall very nice! I like the extra comments in the examples a lot. Also I agree that the readme got too large and contained too much duplicate data. It's indeed better to redirect users to the docs for their specific platforms.
My repeating comments are mostly English related. I think that's extra important for first impressions (which is what the README often is for people), and I do see it could do some work in the untouched parts. I'll have a look later :). And a couple of times you say that "an extension properties API" is generated. I think that's a bit confusing. We have the "Extension Properties (Access) API", the "String (Access) API", etc. But the only thing that's generated are "extension properties", not an entire API. So that could propbably be rephrased better everywhere it's used.
| df // last expression in the cell is displayed | ||
| ``` | ||
|
|
||
| When previous cell with variable declaration is executed, `DataFrame` provides data schema API based on data: |
There was a problem hiding this comment.
"the previous cell"
and "provides a data schema API" or alternatively "provides column accessors for the DataFrame based on the data"
.../src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/movies/moviesWithColumnAccessor.kt
Outdated
Show resolved
Hide resolved
.../src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/movies/moviesWithColumnAccessor.kt
Show resolved
Hide resolved
...ovies/src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/movies/moviesWithDataClass.kt
Outdated
Show resolved
Hide resolved
.../src/main/kotlin/org/jetbrains/kotlinx/dataframe/examples/movies/moviesWithColumnAccessor.kt
Outdated
Show resolved
Hide resolved
| } | ||
| ``` | ||
|
|
||
| ### Jupyter Notebook | ||
| ## Getting started in Jupyter Notebook / Kotlin Notebook | ||
|
|
||
| Install [Kotlin kernel](https://github.com/Kotlin/kotlin-jupyter) for [Jupyter](https://jupyter.org/) | ||
|
|
There was a problem hiding this comment.
Okay, maybe I'll check the docs and readme in the future. We lack articles all over the place. It looks a bit unprofessional to me :/
|
@koperagen could you please in your PR update the df version ctrl-c/ctrl-v to 0.12.1 in the docs? |
I'd use [VERSION] actually, otherwise we might forget it later |
|
I agree that "extension properties API" is not the right term. Later, i'll rename everything to "data schema api". Now i'd like to keep "extension properties API" to emphasize that it's some special term in our library. Consider "// execute |
koperagen
force-pushed
the
documentation-updates
branch
from
e549f8b
to
f3e7e97
Compare
|
I updated to 0.12.1. I'd like to keep version number for peoples convenience |
koperagen
added
the
documentation
Let's try to put getting started snippets right in the README. One important selling point of the DataFrame is ease of working with data snippet you have:
readAPI is straightforward and tooling helps discovering data with completion + types. Thus more emphasize on extension properties API.Some other changes are focused on making things more explicit: why we show this and that