Wasmtime GitHub notifications bot (Mar 13 2024 at 17:36): Wasmtime GitHub notifications bot (Mar 13 2024 at 17:36):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
Wasmtime GitHub notifications bot (Mar 13 2024 at 17:36):flavio requested alexcrichton for a review on PR #8120.
Wasmtime GitHub notifications bot (Mar 13 2024 at 17:36):flavio requested wasmtime-core-reviewers for a review on PR #8120.
Wasmtime GitHub notifications bot (Mar 13 2024 at 17:41):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:
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:21):alexcrichton submitted PR review:
Thanks for this!
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:21):alexcrichton submitted PR review:
Thanks for this!
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:21):alexcrichton created PR review comment:
Mind replacing this with
all-features = true?
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:21):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
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):flavio updated PR #8120.
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):flavio submitted PR review.
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):flavio created PR review comment:
Done
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):flavio submitted PR review.
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):flavio created PR review comment:
Done
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:27):@alexcrichton I've applied your suggesting and ran
RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps. Everything looks good
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:27):alexcrichton commented on PR #8120:
:+1:
Wasmtime GitHub notifications bot (Mar 13 2024 at 18:27):alexcrichton has enabled auto merge for PR #8120.
Wasmtime GitHub notifications bot (Mar 13 2024 at 19:12):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
Wasmtime GitHub notifications bot (Mar 13 2024 at 19:24):alexcrichton merged PR #8120.
Last updated: Oct 23 2024 at 20:03 UTC