Skip to content

add spelling conventions and name fixes in a whole project #1364

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 4 commits into
base: master
Choose a base branch
from
Open

add spelling conventions and name fixes in a whole project #1364

wants to merge 4 commits into from

Conversation

AndreiKingsley
Copy link
Collaborator

@AndreiKingsley AndreiKingsley commented Aug 5, 2025 •
edited by Jolanrensen
Loading

Related to #661

@Jolanrensen
Copy link
Collaborator

*add spelling conventions and name fixes in a the whole project

Jolanrensen
Jolanrensen requested changes Aug 5, 2025
View reviewed changes
Copy link
Collaborator

@Jolanrensen Jolanrensen left a comment

Choose a reason for hiding this comment

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

YES! Thanks!
Just a couple auto-replace mistakes ;P but looks great otherwise

core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/join.kt
@@ -168,12 +168,12 @@ public fun <C> ColumnMatch(left: ColumnReference<C>, right: ColumnReference<C>):
public typealias JoinColumnsSelector<A, B> = JoinDsl<A, B>.(ColumnsContainer<A>) -> ColumnsResolver<*>

public enum class JoinType {
Left, // all data from left data frame, nulls for mismatches in right data frame
Copy link
Collaborator

Choose a reason for hiding this comment

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

wow we really were the definition of inconsistent XD

dataframe-json/src/test/kotlin/org/jetbrains/kotlinx/dataframe/io/JsonTests.kt Outdated
@@ -1075,7 +1075,7 @@ class JsonTests {
}

@Test
fun `json with metadata frame column`() {
fun `json with metadataframe column`() {
Copy link
Collaborator

Choose a reason for hiding this comment

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

this joined the two wrong ones together haha, *metadata FrameColumn. We don't really have a "concept" version of FrameColumn. I guess "frame column" could be right or "frame-column", whatever we choose :) (Unfortunately English has no clear rules when words need to be conjoined or not... Let's make our next library in Dutch or German XD)

docs/StardustDocs/topics/dataSources/Integrations.md Outdated
@@ -1,7 +1,7 @@
# Custom integrations with unsupported data sources

<web-summary>
Examples of how to integrate Kotlin DataFrame with other data frameworks like Exposed, Spark, or Multik.
Examples of how to integrate Kotlin DataFrame with other dataframeworks like Exposed, Spark, or Multik.
Copy link
Collaborator

Choose a reason for hiding this comment

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

nope XD

docs/StardustDocs/topics/dataSources/Integrations.md Outdated
@@ -15,7 +15,7 @@ How to connect Kotlin DataFrame with data sources like Exposed, Apache Spark, or
Some data sources are not officially supported in the Kotlin DataFrame API yet —
but you can still integrate them easily using custom code.

Below is a list of example integrations with other data frameworks.
Below is a list of example integrations with other dataframeworks.
Copy link
Collaborator

Choose a reason for hiding this comment

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

also nope

docs/StardustDocs/topics/spellingConventions.md Outdated

While reading Kotlin DataFrame documentation, you may come across several similar terms referring to different concepts:

* **Kotlin DataFrame** — the name of the official library.
Copy link
Collaborator

Choose a reason for hiding this comment

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

yes, important to mention that we often abbreviate this to "DataFrame". Not no be confused with the type "DataFrame", but that one always has code-style applied to it... hopefully

Copy link
Collaborator

Choose a reason for hiding this comment

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

"Kotlin DataFrame" or "DataFrame" for short

docs/StardustDocs/topics/spellingConventions.md Outdated

* **Kotlin DataFrame** — the name of the official library.
* *dataframe* — a general term for data in a tabular (frame) format.
* [`DataFrame`](DataFrame.md) — a Kotlin type or its instance that represents a wrapper around a dataframe.
Copy link
Collaborator

Choose a reason for hiding this comment

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

yes, important to mention this has backticks (or code formatting) around it

examples/idea-examples/json/src/main/resources/api_guru_list.json Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

pretty sure this file doesn't need to change

examples/notebooks/dev/json/api_guru_list.json Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

same here

examples/notebooks/json/api_guru_list.json Outdated
Copy link
Collaborator

Choose a reason for hiding this comment

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

same here

@Jolanrensen Jolanrensen added the documentation Improvements or additions to documentation (not KDocs) label Aug 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Jolanrensen Jolanrensen Awaiting requested review from Jolanrensen

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation (not KDocs)
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@AndreiKingsley @Jolanrensen