Skip to content

Commit 05519d5

Browse files
committed
Change suggested way of checkings docs example formatting
1 parent 353eacd commit 05519d5

File tree

2 files changed

+2
-2
lines changed

2 files changed

+2
-2
lines changed

.github/workflows/test-docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,4 +29,4 @@ jobs:
2929
- name: Check docs build
3030
run: hatch run docs:build
3131
- name: Check docs examples
32-
run: hatch run docs:check_examples
32+
run: hatch fmt docs --check

docs/src/about/contributing.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ By utilizing `hatch`, the following commands are available to manage the develop
7676
| `hatch run docs:serve` | Start the [`mkdocs`](https://www.mkdocs.org/) server to view documentation locally |
7777
| `hatch run docs:build` | Build the documentation |
7878
| `hatch run docs:linkcheck` | Check for broken links in the documentation |
79-
| `hatch run docs:check_examples` | Run linter on code examples in the documentation |
79+
| `hatch fmt docs --check` | Run linter on code examples in the documentation |
8080

8181
### Environment Management
8282

0 commit comments

Comments
 (0)