chore: check documentation lint (#454)

This commit is contained in:
Valentin271 2023-09-02 04:59:07 +02:00 committed by GitHub
parent ea70bffe5d
commit 5f6aa30be5
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 16 additions and 1 deletions

View file

@ -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

View file

@ -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"
@ -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"