Skip to content

Commit 47b73d7

Browse files
committed
sync docs changes to md
1 parent 3fac8a8 commit 47b73d7

File tree

4 files changed

+21
-19
lines changed

4 files changed

+21
-19
lines changed

Makefile

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,5 +23,8 @@ build:
2323
publish:
2424
uv publish
2525

26-
build_docs:
26+
docs_build:
2727
mkdocs build -f docs_sources/mkdocs.yml -d ../docs
28+
29+
docs_serve:
30+
mkdocs serve -f docs_sources/mkdocs.yml

docs/index.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,5 +221,5 @@ <h2 id="how-it-works">How it works</h2>
221221

222222
<!--
223223
MkDocs version : 1.6.1
224-
Build Date UTC : 2026-01-12 21:26:27.089860+00:00
224+
Build Date UTC : 2026-01-12 21:31:58.475550+00:00
225225
-->

docs/testing/index.html

Lines changed: 9 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -111,21 +111,19 @@ <h1 id="testing">Testing</h1>
111111
<ol>
112112
<li>
113113
<p><strong>Separate sessions</strong>: The test uses its own session that prepares data and
114-
verifies results after execution. The application also has its own session.</p>
115-
</li>
116-
<li>
117-
<p>It is a more "honest" way to test the application.</p>
118-
</li>
114+
verifies results after execution. The application also has its own session.</p>
115+
<ul>
116+
<li>It is a more "honest" way to test the application.</li>
119117
<li>Verifies how it handles sessions and transactions automatically.</li>
120-
<li>
121-
<p>The ability to inspect the database state when the test is paused.
122-
Complex session management scenarios make other test methods difficult or impossible (e.g., concurrent query execution).</p>
118+
<li>The ability to inspect the database state when the test is paused.</li>
119+
<li>Complex session management scenarios make other test methods difficult or impossible (e.g., concurrent query execution).</li>
120+
</ul>
123121
</li>
124122
<li>
125123
<p><strong>Shared session and transaction</strong>: The test and the application share the same session and transaction.</p>
126-
</li>
127-
<li>
128-
<p>Rolling back transactions is faster and takes less time than starting a new session.</p>
124+
<ul>
125+
<li>Rolling back transactions is faster and takes less time than starting a new session.</li>
126+
</ul>
129127
</li>
130128
</ol>
131129
<p>In my projects, I use both approaches at the same time:</p>

docs_sources/docs/testing.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,17 @@ When testing with a real database, one important problem needs to be solved: ens
55
There are two approaches:
66

77
1. **Separate sessions**: The test uses its own session that prepares data and
8-
verifies results after execution. The application also has its own session.
8+
verifies results after execution. The application also has its own session.
99

10-
- It is a more "honest" way to test the application.
11-
- Verifies how it handles sessions and transactions automatically.
12-
- The ability to inspect the database state when the test is paused.
13-
Complex session management scenarios make other test methods difficult or impossible (e.g., concurrent query execution).
10+
- It is a more "honest" way to test the application.
11+
- Verifies how it handles sessions and transactions automatically.
12+
- The ability to inspect the database state when the test is paused.
13+
- Complex session management scenarios make other test methods difficult or impossible (e.g., concurrent query execution).
1414

1515
2. **Shared session and transaction**: The test and the application share the same session and transaction.
1616

17-
- Rolling back transactions is faster and takes less time than starting a new session.
17+
- Rolling back transactions is faster and takes less time than starting a new session.
18+
1819

1920

2021
In my projects, I use both approaches at the same time:

0 commit comments

Comments
 (0)