-
Notifications
You must be signed in to change notification settings - Fork 751
docs: Add section on DSL buildStatement() and prepareSQL() #2563
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
Conversation
|
@vnikolova This is sort of a draft following a TODO I'm resolving, in that I'm willing to have any of the following changed depending on your advice:
I just wanted to lay out the content for the final api, so feel free to push any changes you think are best. |
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
vnikolova
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this addition @bog-walk!
Looks great - I only suggest a different title and using second person whenever possible.
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
documentation-website/Writerside/topics/DSL-Statement-Builder.md
Outdated
Show resolved
Hide resolved
c8050d9 to
b96b8bc
Compare
- Docs currently missing section about prepareSQL() - New V1 functionality not documented anywhere
Co-authored-by: Vik Nikolova <[email protected]>
- Add review suggestion - Add new example file in exposed-dsl snippets project - Replace hard-coded examples with reference to new file
- Fix detekt issues
- Add missing api links
f669ff8 to
0c569fc
Compare
Description
Summary of the change: Add subsection to DSL root about statement builder
Detailed description:
Why:
Query.prepareSQL()except in FAQbuildStatement()functionality not documented yetWhat:
prepareSQL()with queriesbuildStatement()introduced in V1exec()Type of Change
Please mark the relevant options with an "X":