Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enable the cfg_doc feature on docs.rs #4039

Closed
Michael-F-Bryan opened this issue Jun 27, 2023 · 0 comments · Fixed by #4064
Closed

Enable the cfg_doc feature on docs.rs #4039

Michael-F-Bryan opened this issue Jun 27, 2023 · 0 comments · Fixed by #4064
Labels
priority-low Low priority issue
Milestone

Comments

@Michael-F-Bryan
Copy link
Contributor

Describe the bug

The wasmer crate uses conditional compilation to add/remove a lot of functionality from the public API, but at the moment there's no easy way to tell what is available when you check out the docs. Rustdoc actually has a doc_cfg feature which will show a message like "Available on crate feature fs only".

Solution

We can fix this pretty easily by updating the wasmer crate's lib.rs.

#![cfg_attr(docsrs, feature(doc_cfg))]

(from the lib.rs in tokio)

@Michael-F-Bryan Michael-F-Bryan added this to the v4.0.1 milestone Jun 27, 2023
@ptitSeb ptitSeb added the priority-low Low priority issue label Jul 4, 2023
@ptitSeb ptitSeb modified the milestones: v4.1, v4.2 Jul 4, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
priority-low Low priority issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants