Skip to content

Commit b89db65

Browse files
committed
fix: migrate to latest mdformat
1 parent f9de303 commit b89db65

File tree

4 files changed

+34
-33
lines changed

4 files changed

+34
-33
lines changed

tests/format/fixtures/semantic_indent.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -258,9 +258,9 @@ Table
258258
|:---------------|---------:|:---------------------|
259259
| Name | 2| <!-- Comment --> |
260260
.
261-
| Label | Rating | Comment |
261+
| Label | Rating | Comment |
262262
|:---------------|---------:|:---------------------|
263-
| Name | 2| <!-- Comment --> |
263+
| Name | 2| <!-- Comment --> |
264264
.
265265

266266
Floating Link
@@ -288,26 +288,26 @@ Headings
288288

289289
###### [h6] The smallest heading
290290
.
291-
# \[h1\] The largest heading
291+
# [h1] The largest heading
292292

293-
## \[h2\] heading
293+
## [h2] heading
294294

295-
### \[h3\] heading
295+
### [h3] heading
296296

297-
#### \[h4\] heading
297+
#### [h4] heading
298298

299-
##### \[h5\] heading
299+
##### [h5] heading
300300

301-
###### \[h6\] The smallest heading
301+
###### [h6] The smallest heading
302302
.
303303

304304
Task List / Check List (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)
305305
.
306306
- [x] #739
307307
- [ ] Add delight to the experience when all tasks are complete :tada:
308308
.
309-
- \[x\] #739
310-
- \[ \] Add delight to the experience when all tasks are complete :tada:
309+
- [x] #739
310+
- [ ] Add delight to the experience when all tasks are complete :tada:
311311
.
312312

313313
Footnotes (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)
@@ -320,9 +320,9 @@ You can also use words, to fit your writing style more closely[^note].
320320
[^note]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.\
321321
This footnote also has been made with a different syntax using 4 spaces for new lines.
322322
.
323-
Here is a simple footnote\[^1\].
323+
Here is a simple footnote[^1].
324324

325-
You can also use words, to fit your writing style more closely\[^note\].
325+
You can also use words, to fit your writing style more closely[^note].
326326

327327
\[^1\]: My reference.
328328
\[^note\]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.\

tests/format/fixtures/text.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -257,9 +257,9 @@ Table
257257
|:---------------|---------:|:---------------------|
258258
| Name | 2| <!-- Comment --> |
259259
.
260-
| Label | Rating | Comment |
260+
| Label | Rating | Comment |
261261
|:---------------|---------:|:---------------------|
262-
| Name | 2| <!-- Comment --> |
262+
| Name | 2| <!-- Comment --> |
263263
.
264264

265265
Floating Link
@@ -287,26 +287,26 @@ Headings
287287

288288
###### [h6] The smallest heading
289289
.
290-
# \[h1\] The largest heading
290+
# [h1] The largest heading
291291

292-
## \[h2\] heading
292+
## [h2] heading
293293

294-
### \[h3\] heading
294+
### [h3] heading
295295

296-
#### \[h4\] heading
296+
#### [h4] heading
297297

298-
##### \[h5\] heading
298+
##### [h5] heading
299299

300-
###### \[h6\] The smallest heading
300+
###### [h6] The smallest heading
301301
.
302302

303303
Task List / Check List (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)
304304
.
305305
- [x] #739
306306
- [ ] Add delight to the experience when all tasks are complete :tada:
307307
.
308-
- \[x\] #739
309-
- \[ \] Add delight to the experience when all tasks are complete :tada:
308+
- [x] #739
309+
- [ ] Add delight to the experience when all tasks are complete :tada:
310310
.
311311

312312
Footnotes (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)
@@ -319,9 +319,9 @@ You can also use words, to fit your writing style more closely[^note].
319319
[^note]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.\
320320
This footnote also has been made with a different syntax using 4 spaces for new lines.
321321
.
322-
Here is a simple footnote\[^1\].
322+
Here is a simple footnote[^1].
323323

324-
You can also use words, to fit your writing style more closely\[^note\].
324+
You can also use words, to fit your writing style more closely[^note].
325325

326326
\[^1\]: My reference.
327327
\[^note\]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.\
@@ -1148,7 +1148,7 @@ Example from Ultralytics Documentation (https://github.com/ultralytics/ultralyti
11481148
- Finally the image region for the bounding box is cropped using index slicing, where the bounds are set using the `[ymin:ymax, xmin:xmax]` coordinates of the detection bounding box.
11491149
11501150
??? question "What if I want the cropped object **including** the background?"
1151-
This is a built in feature for the Ultralytics library. See the `save_crop` argument for [Predict Mode Inference Arguments](../modes/predict.md/#inference-arguments) for details.
1151+
This is a built in feature for the Ultralytics library. See the `save_crop` argument for [Predict Mode Inference Arguments](../modes/predict.md/#inference-arguments) for details.
11521152
11531153
______________________________________________________________________
11541154
.
@@ -1454,8 +1454,8 @@ Without CLI argument, does not support Python mkdocstring cross-references (http
14541454
[package.module.object][]
14551455
[Object][package.module.object]
14561456
.
1457-
\[package.module.object\]\[\]
1458-
\[Object\]\[package.module.object\]
1457+
[package.module.object][]
1458+
[Object][package.module.object]
14591459
.
14601460
14611461
Do not format lists in code blocks

tests/pre-commit-test.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ ______________________________________________________________________
1818

1919
### **Typo**
2020

21-
# \[h1\] The largest heading
21+
# [h1] The largest heading
2222

23-
## \[h2\] heading
23+
## [h2] heading
2424

25-
### \[h3\] heading
25+
### [h3] heading
2626

27-
#### \[h4\] heading
27+
#### [h4] heading
2828

29-
##### \[h5\] heading
29+
##### [h5] heading
3030

31-
###### \[h6\] The smallest heading
31+
###### [h6] The smallest heading
3232

3333
______________________________________________________________________
3434

tox.ini

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ skip_missing_interpreters = False
1111

1212
[testenv:py{312}-beartype]
1313
extras = test
14+
deps = -e git+https://github.com/executablebooks/mdformat.git\#egg=mdformat
1415
commands = pytest {posargs} --ff --nf -vv --exitfirst --beartype-packages='mdformat_mkdocs'
1516

1617
[testenv:py{39}-snapshot-update]

0 commit comments

Comments
 (0)