Column Selector Grammar in docs #619
Merged
Conversation
This file contains 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
added
documentation
…st columnSet/columnGroup line
Jolanrensen
force-pushed
the
column-selector-docs
branch
from
1f7d9fa
to
80bbb32
Compare
|
@Jolanrensen what is the status of this PR? |
|
It's probably ready to be merged:
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 :) |
Jolanrensen
force-pushed
the
column-selector-docs
branch
from
00a4258
to
621f1e4
Compare
Jolanrensen
requested review from
zaleslaw and
koperagen
and removed request for
zaleslaw and
koperagen
zaleslaw
approved these changes
Jun 10, 2024
| @@ -128,7 +128,10 @@ val samplesTest = tasks.register<Test>("samplesTest") { | |||
| ignoreFailures = true | |||
|
|
|||
| testClassesDirs = fileTree("${layout.buildDirectory.get().asFile.path}/classes/testWithOutputs/kotlin") | |||
| classpath = files("${layout.buildDirectory.get().asFile.path}/classes/testWithOutputs/kotlin") + configurations["samplesRuntimeClasspath"] + sourceSets["main"].runtimeClasspath | |||
| classpath = | |||
There was a problem hiding this comment.
Could you please add any comment, why classpath consist from these three parts
There was a problem hiding this comment.
I'm not 100% sure actually, I just reformatted the line because it was too long
|
|
||
|
|
||
|
|
||
|
|
There was a problem hiding this comment.
is it fine to have so much blank lines?
There was a problem hiding this comment.
It's the result of @ExcludeFromSources which removes some documentation interfaces. The newlines are originally from in between these interfaces.
When we've updated our linter (#364) I'll turn on the auto-reformat for generated files, so we can fix these cases :)
| * You can use @exportAsHtmlStart and @exportAsHtmlEnd to specify a range of the doc to | ||
| * export to HTML. | ||
| * | ||
| * Do not rename! |
There was a problem hiding this comment.
Make here more stronger; NOTE: DO NOT RENAME!!!!
| } | ||
| </style> | ||
| </head> | ||
| <body><p><code><code>columnGroup</code></code></p><p> <code>| </code><code><strong><code>[</code></strong></code><code><code>column</code></code><strong><code>,</code></strong><code> ..</code><code><strong><code>]</code></strong></code></p><p> <code>| </code><code><strong><code>[</code></strong></code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code><strong><code>]</code></strong></code></p><p> <code>| </code><code><strong><code>{</code></strong></code><code> </code><code><code>colsSelector</code></code><code> </code><code><strong><code>}</code></strong></code></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>allCols</code></strong></code><strong><code>()</code></strong></p><p> <code>| </code><strong><code>.allCols</code></strong><code>(</code><code><strong><code>Before</code></strong></code><code>|</code><code><strong><code>After</code></strong></code><code>|</code><code><strong><code>From</code></strong></code><code>|</code><code><strong><code>UpTo</code></strong></code><code>) ( </code><strong><code>(</code></strong><code><code>column</code></code><strong><code>)</code></strong><code> | </code><strong><code>{ </code></strong><code><code>colSelector</code></code><strong><code> }</code></strong><code> )</code></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>allColsExcept</code></strong></code><strong><code> { </code></strong><code><code>colsSelector</code></code><strong><code> } </code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>allColsExcept</code></strong></code><strong><code>(</code></strong><code><code>columnNoAccessor</code></code><strong><code>,</code></strong><code> ..</code><strong><code>)</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>and</code></strong></code><strong><code> (</code></strong><code>|</code><strong><code>{ </code></strong><code><code>columnOrSet</code></code><strong><code> }</code></strong><code>|</code><strong><code>)</code></strong></p><p> <code>| (</code><strong><code>.</code></strong><code><strong><code>col</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>valueCol</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>frameCol</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>colGroup</code></strong></code><code>)[</code><strong><code><</code></strong><code><code>T</code></code><strong><code>></code></strong><code>]</code><strong><code>(</code></strong><code><code>column</code></code><code> | </code><code><code>index</code></code><strong><code>)</code></strong></p><p> <code>| (</code><strong><code>.</code></strong><code><strong><code>cols</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>valueCols</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>frameCols</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>colGroups</code></strong></code><code>) [ </code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code> ]</code></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>cols</code></strong></code><code>[</code><strong><code><</code></strong><code><code>T</code></code><strong><code>></code></strong><code>]</code><strong><code>(</code></strong><code><code>column</code></code><strong><code>,</code></strong><code>.. |</code><code><code>index</code></code><strong><code>,</code></strong><code>.. |</code><code><code>indexRange</code></code><strong><code>)</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>colsAtAnyDepth</code></strong></code><code> [ </code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code> ]</code></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>colsInGroups</code></strong></code><code> [ </code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code> ]</code></p><p> <code>| </code><strong><code>.colsName</code></strong><code>(</code><code><strong><code>Starts</code></strong></code><code>|</code><code><strong><code>Ends</code></strong></code><code>)</code><strong><code>With</code></strong><strong><code>(</code></strong><code><code>text</code></code><code>[</code><strong><code>, </code></strong><code><code>ignoreCase</code></code><code>]</code><strong><code>)</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>colsNameContains</code></strong></code><strong><code>(</code></strong><code><code>text</code></code><code>[</code><strong><code>, </code></strong><code><code>ignoreCase</code></code><code>] | </code><code><code>regex</code></code><strong><code>)</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>colsOfKind</code></strong></code><strong><code>(</code></strong><code><code>kind</code></code><strong><code>,</code></strong><code> ..</code><strong><code>)</code></strong><code> [ </code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code> ]</code></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>colsWithoutNulls</code></strong></code><strong><code>()</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>drop</code></strong></code><code>(</code><code><strong><code>Last</code></strong></code><code>)</code><code><strong><code>Cols</code></strong></code><strong><code>(</code></strong><code><code>number</code></code><strong><code>)</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>drop</code></strong></code><code>(</code><code><strong><code>Last</code></strong></code><code>)</code><code><strong><code>ColsWhile</code></strong></code><strong><code> { </code></strong><code><code>condition</code></code><strong><code> }</code></strong></p><p> <code>| </code><code><strong><code>exceptNew</code></strong></code><strong><code> { </code></strong><code><code>colsSelector</code></code><strong><code> } EXPERIMENTAL!</code></strong></p><p> <code>| </code><code><strong><code>exceptNew</code></strong></code><strong><code>(</code></strong><code><code>columnNoAccessor</code></code><strong><code>,</code></strong><code> ..</code><strong><code>) EXPERIMENTAL!</code></strong></p><p> <code>| (</code><strong><code>.</code></strong><code><strong><code>firstCol</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>lastCol</code></strong></code><code>| </code><strong><code>.</code></strong><code><strong><code>singleCol</code></strong></code><code>) [ </code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code> ]</code></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>select</code></strong></code><strong><code> { </code></strong><code><code>colsSelector</code></code><strong><code> }</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>take</code></strong></code><code>(</code><code><strong><code>Last</code></strong></code><code>)</code><code><strong><code>Cols</code></strong></code><strong><code>(</code></strong><code><code>number</code></code><strong><code>)</code></strong></p><p> <code>| </code><strong><code>.</code></strong><code><strong><code>take</code></strong></code><code>(</code><code><strong><code>Last</code></strong></code><code>)</code><code><strong><code>ColsWhile</code></strong></code><strong><code> { </code></strong><code><code>condition</code></code><strong><code> }</code></strong></p><p> </p><p><code><code>singleColumn</code></code></p><p> <strong><code>.</code></strong><code><strong><code>colsOf</code></strong></code><strong><code><</code></strong><code><code>T</code></code><strong><code>></code></strong><code> [ </code><strong><code>(</code></strong><code><code>kType</code></code><strong><code>)</code></strong><code> ] [ </code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code> ]</code></p><p> </p><p><code><code>columnGroupReference</code></code></p><p> <strong><code>.</code></strong><code><strong><code>colsOf</code></strong></code><strong><code><</code></strong><code><code>T</code></code><strong><code>>(</code></strong><code><code>kType</code></code><strong><code>)</code></strong><code> [ </code><strong><code>{ </code></strong><code><code>condition</code></code><strong><code> }</code></strong><code> ]</code></p></body> |
There was a problem hiding this comment.
How it was generated? If I need somehow to change it in the future, how I could do this? Is it a result of preprocessor work?
There was a problem hiding this comment.
Yep, all we need is the @ExportAsHtml annotation on a KDoc-holding element and the preprocessor will generate a file like this in the snippets folder :).
If you change something in the KDoc of that interface and run the preprocessor like normal, the html file will be updated as well automatically.
Like:
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.
Works on #570
Started the process for writing docs for the columns selection DSL. Since the latest doc preprocessor update we are able to
@ExportAsHtmlany 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 #613Aside 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).