flavio opened PR #8120 from flavio:wasi-common-docs-cover-feature-based-code
to bytecodealliance:main
:
Ensure the docs of wasi-common show also code that depends on certain feature flags being enabled.
Fixes https://github.com/bytecodealliance/wasmtime/issues/8119
flavio requested alexcrichton for a review on PR #8120.
flavio requested wasmtime-core-reviewers for a review on PR #8120.
flavio edited PR #8120:
Ensure the docs of wasi-common show also code that depends on certain feature flags being enabled.
Fixes https://github.com/bytecodealliance/wasmtime/issues/8119
This is how the docs look with this patch applies, I've highlighted the information that was previously hidden:
![Screenshot 2024-03-13 at 18-38-32 wasi_common - Rust](https://github.com/bytecodealliance/wasmtime/assets/22728/6f405662-171b-4375-aacd-154af03bf922)
alexcrichton submitted PR review:
Thanks for this!
alexcrichton submitted PR review:
Thanks for this!
alexcrichton created PR review comment:
Mind replacing this with
all-features = true
?
alexcrichton created PR review comment:
I think that this is the default on docs.rs, so I think it's ok to leave this out (but still use
cfg_attr(docrs, ...)
in the code
flavio updated PR #8120.
flavio submitted PR review.
flavio created PR review comment:
Done
flavio submitted PR review.
flavio created PR review comment:
Done
@alexcrichton I've applied your suggesting and ran
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps
. Everything looks good
alexcrichton commented on PR #8120:
:+1:
alexcrichton has enabled auto merge for PR #8120.
flavio edited a comment on PR #8120:
@alexcrichton I've applied your suggestions and ran
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps
. Everything looks good
alexcrichton merged PR #8120.
Last updated: Dec 23 2024 at 13:07 UTC