FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

📝 Update admonitions in annotations (#1065) · ByteDecoder/sqlmodel@ee44f3b · GitHub

  1. ByteDecoder
  2. sqlmodel

Repository navigation

Commit ee44f3b

Browse files
tiangolo
authored
📝 Update admonitions in annotations (fastapi#1065)
1 parent d55af68 commit ee44f3b

8 files changed

Lines changed: 71 additions & 32 deletions

File tree

‎docs_src/tutorial/automatic_id_none_refresh/annotations/en/tutorial002.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,11 @@
307307
308308
33. Print the `hero_1`.
309309
310-
!!! info
311-
Even if the `hero_1` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
310+
/// info
311+
312+
Even if the `hero_1` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
313+
314+
///
312315
313316
Because the `hero_1` is fresh it has all it's data available.
314317
@@ -320,8 +323,11 @@
320323
321324
34. Print the `hero_2`.
322325
323-
!!! info
324-
Even if the `hero_2` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
326+
/// info
327+
328+
Even if the `hero_2` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
329+
330+
///
325331
326332
Because the `hero_2` is fresh it has all it's data available.
327333
@@ -333,8 +339,11 @@
333339
334340
35. Print the `hero_3`.
335341
336-
!!! info
337-
Even if the `hero_3` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
342+
/// info
343+
344+
Even if the `hero_3` wasn't fresh, this would **not** trigger a `refresh` making the **session** use the **engine** to fetch data from the database because it is not accessing an attribute.
345+
346+
///
338347
339348
Because the `hero_3` is fresh it has all it's data available.
340349

‎docs_src/tutorial/delete/annotations/en/tutorial002.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,13 @@
1414
1515
3. Get one hero object, expecting exactly one.
1616
17-
!!! tip
18-
This ensures there's no more than one, and that there's exactly one, not `None`.
17+
/// tip
1918
20-
This would never return `None`, instead it would raise an exception.
19+
This ensures there's no more than one, and that there's exactly one, not `None`.
20+
21+
This would never return `None`, instead it would raise an exception.
22+
23+
///
2124
2225
4. Print the hero object.
2326

‎docs_src/tutorial/fastapi/app_testing/tutorial001/annotations/en/test_main_004.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,8 @@
2222
2323
We tell it that with the `poolclass=StaticPool` parameter.
2424
25-
!!! info
26-
You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
25+
/// info
26+
27+
You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
28+
29+
///

‎docs_src/tutorial/fastapi/app_testing/tutorial001_py310/annotations/en/test_main_004.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,8 @@
2222
2323
We tell it that with the `poolclass=StaticPool` parameter.
2424
25-
!!! info
26-
You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
25+
/// info
26+
27+
You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
28+
29+
///

‎docs_src/tutorial/fastapi/app_testing/tutorial001_py39/annotations/en/test_main_004.md‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,5 +22,8 @@
2222
2323
We tell it that with the `poolclass=StaticPool` parameter.
2424
25-
!!! info
26-
You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
25+
/// info
26+
27+
You can read more details in the <a href="https://docs.sqlalchemy.org/en/14/dialects/sqlite.html#using-a-memory-database-in-multiple-threads" class="external-link" target="_blank">SQLAlchemy documentation about Using a Memory Database in Multiple Threads</a>
28+
29+
///

‎docs_src/tutorial/select/annotations/en/tutorial002.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,10 +16,13 @@
1616

1717
7. Create a new **session** to query data.
1818

19-
!!! tip
20-
Notice that this is a new **session** independent from the one in the other function above.
19+
/// tip
2120

22-
But it still uses the same **engine**. We still have one engine for the whole application.
21+
Notice that this is a new **session** independent from the one in the other function above.
22+
23+
But it still uses the same **engine**. We still have one engine for the whole application.
24+
25+
///
2326

2427
8. Use the `select()` function to create a statement selecting all the `Hero` objects.
2528

‎docs_src/tutorial/update/annotations/en/tutorial002.md‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,13 @@
1313
1414
3. Get one hero object, expecting exactly one.
1515
16-
!!! tip
17-
This ensures there's no more than one, and that there's exactly one, not `None`.
16+
/// tip
1817
19-
This would never return `None`, instead it would raise an exception.
18+
This ensures there's no more than one, and that there's exactly one, not `None`.
19+
20+
This would never return `None`, instead it would raise an exception.
21+
22+
///
2023
2124
4. Print the hero object.
2225

‎docs_src/tutorial/update/annotations/en/tutorial004.md‎

Lines changed: 23 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -35,12 +35,15 @@
3535
INFO Engine [no key 0.00020s] ('Captain North America',)
3636
```
3737
38-
!!! tip
39-
See the `BEGIN` at the top?
38+
/// tip
4039
41-
This is SQLAlchemy automatically starting a transaction for us.
40+
See the `BEGIN` at the top?
4241
43-
This way, we could revert the last changes (if there were some) if we wanted to, even if the SQL to create them was already sent to the database.
42+
This is SQLAlchemy automatically starting a transaction for us.
43+
44+
This way, we could revert the last changes (if there were some) if we wanted to, even if the SQL to create them was already sent to the database.
45+
46+
///
4447
4548
7. Get one hero object for this new query.
4649
@@ -98,10 +101,13 @@
98101
INFO Engine COMMIT
99102
```
100103
101-
!!! tip
102-
See how SQLAlchemy (that powers SQLModel) optimizes the SQL to do as much work as possible in a single batch.
104+
/// tip
105+
106+
See how SQLAlchemy (that powers SQLModel) optimizes the SQL to do as much work as possible in a single batch.
107+
108+
Here it updates both heroes in a single SQL query.
103109
104-
Here it updates both heroes in a single SQL query.
110+
///
105111
106112
16. Refresh the first hero.
107113
@@ -115,8 +121,11 @@
115121
INFO Engine [generated in 0.00023s] (2,)
116122
```
117123
118-
!!! tip
119-
Because we just committed a SQL transaction with `COMMIT`, SQLAlchemy will automatically start a new transaction with `BEGIN`.
124+
/// tip
125+
126+
Because we just committed a SQL transaction with `COMMIT`, SQLAlchemy will automatically start a new transaction with `BEGIN`.
127+
128+
///
120129
121130
17. Refresh the second hero.
122131
@@ -129,8 +138,11 @@
129138
INFO Engine [cached since 0.001709s ago] (7,)
130139
```
131140
132-
!!! tip
133-
SQLAlchemy is still using the previous transaction, so it doesn't have to create a new one.
141+
/// tip
142+
143+
SQLAlchemy is still using the previous transaction, so it doesn't have to create a new one.
144+
145+
///
134146
135147
18. Print the first hero, now updated.
136148

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL