Skip to content

Added KDocs guidelines#1660

Open
AndreiKingsley wants to merge 14 commits intomasterfrom
documentation-guidelines
Open

Added KDocs guidelines#1660
AndreiKingsley wants to merge 14 commits intomasterfrom
documentation-guidelines

Conversation

@AndreiKingsley
Copy link
Collaborator

@AndreiKingsley AndreiKingsley commented Jan 19, 2026

Closes #1689

@Jolanrensen
Copy link
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:

  • Kdoc preprocessing
  • Documenting guide

but they should probably link to each other. A single document could also work

@AndreiKingsley AndreiKingsley changed the title Documentation guidelines KDocs guidelines Feb 17, 2026
@AndreiKingsley
Copy link
Collaborator Author

Almost finished, but requires #1683

@AndreiKingsley AndreiKingsley marked this pull request as ready for review March 6, 2026 16:16
@AndreiKingsley AndreiKingsley changed the title KDocs guidelines Added KDocs guidelines Mar 9, 2026
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.

Thanks! This is quite extensive :)


A fully interactive, single-source-of-truth grammar for the Columns Selection DSL!


Copy link
Collaborator

Choose a reason for hiding this comment

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

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

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I do

Please read about 
the [KDocs preprocessing using KoDEx](KODEX_KDOC_PREPROCESSING.md) before working with Kotlin DataFrame KDocs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Make KDoc guidelines

2 participants