Skip to content

Remove some vague/outdated/duplicated paragraphs from README.md#1939

Merged
koperagen merged 1 commit into
masterfrom
cleanup-readme
Jul 23, 2026
Merged

Remove some vague/outdated/duplicated paragraphs from README.md#1939
koperagen merged 1 commit into
masterfrom
cleanup-readme

Conversation

@koperagen

Copy link
Copy Markdown
Collaborator

No description provided.

@koperagen koperagen added this to the 1.0 milestone Jul 21, 2026
@koperagen
koperagen requested a review from AndreiKingsley July 21, 2026 17:32
@koperagen koperagen self-assigned this Jul 21, 2026
@koperagen koperagen added the documentation Improvements or additions to documentation (not KDocs) label Jul 21, 2026
Comment thread README.md
* See [IDEA Gradle example projects](examples)
and [the Gradle project with the Kotlin DataFrame Compiler plugin](examples/projects/kotlin-dataframe-plugin-gradle-example).

Refer to the

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

notebook info in gradle section

Comment thread README.md

Explore [**more examples here**](https://kotlin.github.io/dataframe/guides-and-examples.html).

## Data model

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

very strange place tbh, looks out of place

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Agree

Comment thread README.md
possible.
* **Readable** — data transformation operations are defined in DSL close to natural language.
* **Practical** — provides simple solutions for common problems and the ability to perform complex tasks.
* **Minimalistic** — simple, yet powerful data model of three column kinds.

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

not clear how three column kinds make library minimalistic. other principles better convey some ideas

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

You can rephrase that the "data model is natural and simple to understand yet powerful" smth like that

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

I'll take note to revisit these principles a bit later

Comment thread README.md
[![Dynamic XML Badge](https://img.shields.io/badge/dynamic/xml?url=https%3A%2F%2Frepo1.maven.org%2Fmaven2%2Forg%2Fjetbrains%2Fkotlinx%2Fdataframe%2Fmaven-metadata.xml&query=%2F%2Fversion%5Bcontains%28text%28%29%2C%22dev%22%29%5D%5Blast%28%29%5D&label=Dev%20version&color=yellow
)](https://search.maven.org/artifact/org.jetbrains.kotlinx/dataframe)
[![GitHub License](https://img.shields.io/badge/license-Apache%20License%202.0-blue.svg?style=flat)](http://www.apache.org/licenses/LICENSE-2.0)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/Kotlin/dataframe/HEAD)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

i'd like to de-clutter this row a little. binder is nice but we aim more to showcase idea projects, don't we

@koperagen
koperagen merged commit 9b389d9 into master Jul 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation (not KDocs)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants