Skip to content
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.

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

Column Selector Grammar in docs #619

Open
wants to merge 10 commits into
base: master
Choose a base branch
from
Open

Conversation

Jolanrensen
Copy link
Collaborator

@Jolanrensen Jolanrensen commented Mar 12, 2024

Works on #570

Started the process for writing docs for the columns selection DSL. Since the latest doc preprocessor update we are able to @ExportAsHtml any KDoc and this PR aims to export the DSL Grammar from the ColumnsSelectionDSL directly on Writerside.

This makes it dependent on previous KDoc fixes in #613

Aside from those general KDoc fixes, this PR removes some nbsp from type definitions (as those don't align in generated HTML), and it splits the ColumnsSelection DSL grammar in separate interfaces so they can be imported into writerside separately and put in a table (fixed by #618).

@Jolanrensen Jolanrensen added documentation Improvements or additions to documentation (not KDocs) KDocs Improvements or additions to KDocs labels Mar 12, 2024
@Jolanrensen Jolanrensen added this to the 0.13.+ milestone Mar 12, 2024
@Jolanrensen Jolanrensen self-assigned this Mar 12, 2024
@Jolanrensen Jolanrensen marked this pull request as draft March 12, 2024 13:34
@zaleslaw zaleslaw modified the milestones: 0.13.+, 0.14.0 Apr 25, 2024
@zaleslaw
Copy link
Collaborator

@Jolanrensen what is the status of this PR?

@Jolanrensen Jolanrensen changed the title Column Selector docs Column Selector Grammar in docs May 30, 2024
@Jolanrensen Jolanrensen marked this pull request as ready for review May 30, 2024 19:01
@Jolanrensen
Copy link
Collaborator Author

Jolanrensen commented May 30, 2024

It's probably ready to be merged:

image

I've limited this PR to just the inclusion of the grammar in the docs. I'll expand upon the documentation in a new PR :)

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) KDocs Improvements or additions to KDocs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants