Add `test --doc` support - Githubissues

rust3ds / cargo-3ds

Cargo command to work with Nintendo 3DS project binaries.

Apache License 2.0

59 stars 10 forks source link

Add `test --doc` support #31

Closed ian-h-chamberlain closed 1 year ago

ian-h-chamberlain commented 1 year ago

Doc tests are... well, kind of an unfinished feature it seems like. A few gaps we will most likely run into:
- We need an unstable flag to even compile doctests: https://github.com/rust-lang/cargo/issues/7040
- --no-run is not supported by rustdoc / cargo:
```
$ cargo 3ds test --doc -Zdoctest-xcompile
No pre-build std found, using build-std
error: Can't skip running doc tests with --no-run
```
  We can probably work around this in cargo-3ds somehow since this still seems to work: cargo test -vvv -Zdoctest-xcompile -Zbuild-std --target armv6k-nintendo-3ds --doc. See also https://github.com/rust-lang/rust/issues/87022

Originally posted by @ian-h-chamberlain in https://github.com/rust3ds/ctru-rs/issues/106#issuecomment-1485803864