chore: check documentation lint

[Valentin271]

Description

Adds a check-doc job to the Makefile. This job checks for errors and warnings in the doc-comments.

Makefile structure

I've added a meta-job check that runs check-code and check-doc.
The check job is run in CI so now the pipelines would check for code and documentation.

check-code replaces the old check job.

For me this is not a breaking change as it concerns tooling and not public APIs. I've also checked every place the cargo check job could have been referenced.

Job implementation

I've used an unstable Rustdoc flag: --check, see here. Here is the tracking issue.

I've used cargo rustdoc instead of cargo doc to pass flags down to rustdoc.
I didn't use the env variable RUSTDOCFLAGS because cargo-make doesn't cleanup task scoped env after execution, so it would interfere with other jobs.

---

Fixes #451

[codecov]

Codecov Report

Merging #454 (5b93ef0) into main (927a5d8) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #454   +/-   ##
=======================================
  Coverage   90.03%   90.03%           
=======================================
  Files          40       40           
  Lines       11127    11127           
=======================================
  Hits        10018    10018           
  Misses       1109     1109           

[Valentin271]

I've added a meta-job check that runs check-code and check-doc.
The check job is run in CI so now the pipelines would check for code and documentation.

check-code replaces the old check job.

For me this is not a breaking change as it concerns tooling and not public APIs. I've also checked every place the cargo check job could have been referenced.

This was failing in the pipeline since the check pipeline wasn't run with nightly.

I think putting check-doc makes more sense in the lint pipeline (style-check Makefile job).
It is already running nightly and only runs on ubuntu which is enough for checking documentation.

[joshka]

Thanks for the PR!