Added KDocs guidelines#1660
Merged
AndreiKingsley merged 14 commits intomasterfrom Mar 10, 2026
Merged
Conversation
Collaborator
|
For visibility, we'd need to merge this with https://github.com/Kotlin/dataframe/blob/master/KDOC_PREPROCESSING.md#kodex-conventions-in-dataframe. It may be okay to have two documents:
but they should probably link to each other. A single document could also work |
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Jolanrensen
reviewed
Jan 19, 2026
Merged
Collaborator
Author
|
Almost finished, but requires #1683 |
# Conflicts: # KDOC_PREPROCESSING.md
…REPROCESSING.md, update references and add section on type aliases
…OperationName~Docs
Jolanrensen
requested changes
Mar 9, 2026
Collaborator
Jolanrensen
left a comment
Jolanrensen
left a comment
There was a problem hiding this comment.
Thanks! This is quite extensive :)
|
|
||
| A fully interactive, single-source-of-truth grammar for the Columns Selection DSL! | ||
|
|
||
|
|
Collaborator
There was a problem hiding this comment.
Do you already link back to KODEX_KDOC_PREPROCESSING.md from this file somewhere? If not, please add it so people that want to find more information about KoDEx can find it
Collaborator
Author
There was a problem hiding this comment.
I do
Please read about
the [KDocs preprocessing using KoDEx](KODEX_KDOC_PREPROCESSING.md) before working with Kotlin DataFrame KDocs.
Jolanrensen
approved these changes
Mar 9, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Closes #1689