add kdocs #1261
Merged
add kdocs #1261
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Jolanrensen requested changes Jun 26, 2025
| * `add` operation adds new columns to DataFrame. | ||
| */ | ||
| | ||
| // region Add existing columns |
There was a problem hiding this comment.
A lot of repetitions here, but probably okay if we don't have to change it often in the future
There was a problem hiding this comment.
IMHO it's hard to find exact repetitions that can be replaces with kodex templates 😢.
There was a problem hiding this comment.
done for add expression description
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/add.kt Outdated Show resolved Hide resolved
| * Creates a new column using [AddExpression] and | ||
| * adds a new column to the end of this [DataFrame] (at the top level). | ||
| * | ||
| * An [AddExpression] allows to compute a value for each row in the new column |
There was a problem hiding this comment.
sounds a bit unnatural.
With [expression] you can define the value each row in the new column needs to have. This can be based on the values from that row in the original dataframe.
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/add.kt Outdated Show resolved Hide resolved
core/src/main/kotlin/org/jetbrains/kotlinx/dataframe/api/add.kt Outdated Show resolved Hide resolved
Jolanrensen approved these changes Jun 27, 2025
| * Original [DataFrame] is not modified. | ||
| * You can also use functions like [prev] and [next] to access other rows, and combine them with | ||
| * [newValue][AddDataRow.newValue] to reference values already computed in the new column. | ||
| * For example, use `prev().newValue()` to access the new column value from the previous row. |
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
add#816(except AddDsl Improve AddDsl #1260)