Stream: git-wasmtime

Topic: wasmtime / PR #8120 wasi-common docs: show feature relate...

view this post on Zulip 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

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 17:36):

flavio requested alexcrichton for a review on PR #8120.

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 17:36):

flavio requested wasmtime-core-reviewers for a review on PR #8120.

view this post on Zulip 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:

![Screenshot 2024-03-13 at 18-38-32 wasi_common - Rust](https://github.com/bytecodealliance/wasmtime/assets/22728/6f405662-171b-4375-aacd-154af03bf922)

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:21):

alexcrichton submitted PR review:

Thanks for this!

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:21):

alexcrichton submitted PR review:

Thanks for this!

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:21):

alexcrichton created PR review comment:

Mind replacing this with all-features = true?

view this post on Zulip 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

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):

flavio updated PR #8120.

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):

flavio submitted PR review.

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):

flavio created PR review comment:

Done

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):

flavio submitted PR review.

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:26):

flavio created PR review comment:

Done

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:27):

flavio commented on PR #8120:

@alexcrichton I've applied your suggesting and ran RUSTDOCFLAGS="--cfg docsrs" cargo +nightly doc --all-features --no-deps. Everything looks good

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:27):

alexcrichton commented on PR #8120:

:+1:

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 18:27):

alexcrichton has enabled auto merge for PR #8120.

view this post on Zulip 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

view this post on Zulip Wasmtime GitHub notifications bot (Mar 13 2024 at 19:24):

alexcrichton merged PR #8120.

Last updated: Feb 28 2025 at 02:27 UTC