Skip to content

Commit

Permalink
chore: check documentation lint (#454)
Browse files Browse the repository at this point in the history
  • Loading branch information
Valentin271 authored Sep 2, 2023
1 parent ea70bff commit 5f6aa30
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 1 deletion.
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,8 @@ jobs:
uses: taiki-e/install-action@cargo-make
- name: Check formatting
run: cargo make fmt
- name: Check documentation
run: cargo make check-doc

clippy:
runs-on: ubuntu-latest
Expand Down
15 changes: 14 additions & 1 deletion Makefile.toml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ dependencies = [

[tasks.style-check]
description = "Check code style"
dependencies = ["fmt", "typos"]
dependencies = ["fmt", "typos", "check-doc"]

[tasks.fmt]
description = "Format source code"
Expand All @@ -34,6 +34,19 @@ description = "Run typo checks"
install_crate = { crate_name = "typos-cli", binary = "typos", test_arg = "--version" }
command = "typos"

[tasks.check-doc]
description = "Check documentation for errors and warnings"
toolchain = "nightly"
command = "cargo"
args = [
"rustdoc",
"--all-features",
"--",
"-Zunstable-options",
"--check",
"-Dwarnings"
]

[tasks.check]
description = "Check code for errors and warnings"
command = "cargo"
Expand Down

0 comments on commit 5f6aa30

Please sign in to comment.