Skip to content

Commit

Permalink
fix: migrate to latest mdformat
Browse files Browse the repository at this point in the history
  • Loading branch information
KyleKing committed Oct 30, 2024
1 parent f9de303 commit b89db65
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 33 deletions.
24 changes: 12 additions & 12 deletions tests/format/fixtures/semantic_indent.md
Original file line number Diff line number Diff line change
Expand Up @@ -258,9 +258,9 @@ Table
|:---------------|---------:|:---------------------|
| Name | 2| <!-- Comment --> |
.
| Label | Rating | Comment |
| Label | Rating | Comment |
|:---------------|---------:|:---------------------|
| Name | 2| <!-- Comment --> |
| Name | 2| <!-- Comment --> |
.

Floating Link
Expand Down Expand Up @@ -288,26 +288,26 @@ Headings

###### [h6] The smallest heading
.
# \[h1\] The largest heading
# [h1] The largest heading

## \[h2\] heading
## [h2] heading

### \[h3\] heading
### [h3] heading

#### \[h4\] heading
#### [h4] heading

##### \[h5\] heading
##### [h5] heading

###### \[h6\] The smallest heading
###### [h6] The smallest heading
.

Task List / Check List (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)
.
- [x] #739
- [ ] Add delight to the experience when all tasks are complete :tada:
.
- \[x\] #739
- \[ \] Add delight to the experience when all tasks are complete :tada:
- [x] #739
- [ ] Add delight to the experience when all tasks are complete :tada:
.

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

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

\[^1\]: My reference.
\[^note\]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.\
Expand Down
30 changes: 15 additions & 15 deletions tests/format/fixtures/text.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,9 +257,9 @@ Table
|:---------------|---------:|:---------------------|
| Name | 2| <!-- Comment --> |
.
| Label | Rating | Comment |
| Label | Rating | Comment |
|:---------------|---------:|:---------------------|
| Name | 2| <!-- Comment --> |
| Name | 2| <!-- Comment --> |
.

Floating Link
Expand Down Expand Up @@ -287,26 +287,26 @@ Headings

###### [h6] The smallest heading
.
# \[h1\] The largest heading
# [h1] The largest heading

## \[h2\] heading
## [h2] heading

### \[h3\] heading
### [h3] heading

#### \[h4\] heading
#### [h4] heading

##### \[h5\] heading
##### [h5] heading

###### \[h6\] The smallest heading
###### [h6] The smallest heading
.

Task List / Check List (WARN: escaping is prevented by mdformat-gfm. Tested by py#-hook)
.
- [x] #739
- [ ] Add delight to the experience when all tasks are complete :tada:
.
- \[x\] #739
- \[ \] Add delight to the experience when all tasks are complete :tada:
- [x] #739
- [ ] Add delight to the experience when all tasks are complete :tada:
.

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

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

\[^1\]: My reference.
\[^note\]: Named footnotes will still render with numbers instead of the text but allow easier identification and linking.\
Expand Down Expand Up @@ -1148,7 +1148,7 @@ Example from Ultralytics Documentation (https://github.com/ultralytics/ultralyti
- 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.
??? question "What if I want the cropped object **including** the background?"
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.
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.
______________________________________________________________________
.
Expand Down Expand Up @@ -1454,8 +1454,8 @@ Without CLI argument, does not support Python mkdocstring cross-references (http
[package.module.object][]
[Object][package.module.object]
.
\[package.module.object\]\[\]
\[Object\]\[package.module.object\]
[package.module.object][]
[Object][package.module.object]
.
Do not format lists in code blocks
Expand Down
12 changes: 6 additions & 6 deletions tests/pre-commit-test.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ ______________________________________________________________________

### **Typo**

# \[h1\] The largest heading
# [h1] The largest heading

## \[h2\] heading
## [h2] heading

### \[h3\] heading
### [h3] heading

#### \[h4\] heading
#### [h4] heading

##### \[h5\] heading
##### [h5] heading

###### \[h6\] The smallest heading
###### [h6] The smallest heading

______________________________________________________________________

Expand Down
1 change: 1 addition & 0 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ skip_missing_interpreters = False

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

[testenv:py{39}-snapshot-update]
Expand Down

0 comments on commit b89db65

Please sign in to comment.