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

docs: EXPOSED-684 Add documentation for exec() and move transaction docs to new element #2385

Merged
merged 1 commit into from
Feb 2, 2025

Conversation

bog-walk
Copy link
Member

@bog-walk bog-walk commented Jan 31, 2025

Description

Summary of the change: Documentation about transactions now has its own top-level element with existing documentation as subtopics along with a new subtopic on working with SQL strings via exec().

Detailed description:

  • Why:

There have been issues/questions in the past about the proper way to use exec() and the only documentation mentioning it is currently in the FAQ page.

There is a lot of information crammed into the single Transactions.md, which most likely deserves to be split and fleshed out into subtopics. Since the concept of a transaction is huge, and intertwines with other Exposed topics like exec(), Statements, and interceptors, it most likely needs its own section.

  • How:
    • Remove FAQ section on how to use sql strings
    • Move original Transactions.md file and place it under a new top-level element 'Transactions'
    • Extract subsection on StatementInterceptors from Transactions.md to its own md file
    • Add new Working-with-SQL-Strings.md file that covers exec() information
    • Create new snippets project exposed-transactions that currently only has new code examples for new topic

Type of Change

Please mark the relevant options with an "X":

  • Documentation update

Checklist

  • The build is green (including the Detekt check)
  • Documentation for my change is up to date

Related Issues

EXPOSED-684

@bog-walk bog-walk requested a review from vnikolova January 31, 2025 01:37
Copy link
Collaborator

@vnikolova vnikolova left a comment

Choose a reason for hiding this comment

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

Looks great 👍

…ocs to new element

- Move Transactions.md to a new top-level element (Transactions)
- Separate section on statement interceptors to its own topic
- Create new topic about working with SQL strings with exec()
- Put example code for new topic in new exposed-transactions snippets project
@bog-walk bog-walk force-pushed the bog-walk/add-transaction-exec-docs branch from ebf2670 to af7e0b2 Compare February 2, 2025 00:51
@bog-walk bog-walk merged commit f039eff into main Feb 2, 2025
5 checks passed
@bog-walk bog-walk deleted the bog-walk/add-transaction-exec-docs branch February 2, 2025 01:35
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.

2 participants