Feature request: cargo check for documentation

[GuillaumeGomez]

Summary

The --check option has been implemented in rust-lang/rust#78984. It'd be nice to be able to use it through cargo.

Unresolved Issues

No response

Future Extensions

When the --check is stabilized on rustdoc, it'd be nice to run it by default on cargo check.

[Manishearth]

cc @rust-lang/rustdoc

[gilescope]

nice - this is not running the tests I assume? Would love cargo check --all to include doc --check.

[jyn514]

nice - this is not running the tests I assume? Would love cargo check --all to include doc --check.

No, this doesn't currently check doctests. (I assume that's what you mean - running the tests in a command called check seems very confusing).

There's a lot of uncertainty around here right now - here's the most recent discussion: rust-lang/rust#73314 (comment)
That suggests having check --doc and check --doctests be different, but still both be included in --all-targets. I like that idea, I think it's confusing to combine doctests and rustdoc lints.

[jyn514]

#10026 (comment)

There would be a little inconsistency between cargo test --doc and cargo check --doc if the latter checks the docs but not the doc-examples.

@Nemo157 I agree this is confusing, but I don't know if it's more confusing that combining the two; I think it's better to lean on the side of giving people more options.