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 all features in for published Rust Docs of protocols crates #1210

Closed
plebhash opened this issue Oct 14, 2024 · 0 comments · Fixed by #1211
Closed

Enable all features in for published Rust Docs of protocols crates #1210

plebhash opened this issue Oct 14, 2024 · 0 comments · Fixed by #1211
Assignees
Milestone

Comments

@plebhash
Copy link
Collaborator

plebhash commented Oct 14, 2024

Currently, the public Rust Docs for protocols crates are rendered without enabling any of the feature flags available on the crates.

That prevents many important elements from being displayed (e.g.: State in codec_sv2, which depends on the noise_sv2 feature flag being enabled).

In order to change that, we need to add the following to their Cargo.toml:

[package.metadata.docs.rs]
all-features = true

ref: https://docs.rs/about/metadata

@plebhash plebhash added this to the 1.1.0 milestone Oct 14, 2024
@GitGab19 GitGab19 self-assigned this Oct 14, 2024
@GitGab19 GitGab19 moved this from Todo 📝 to Ready For Review 🔍 in SV2 Roadmap 🛣️ Oct 14, 2024
@github-project-automation github-project-automation bot moved this from Ready For Review 🔍 to Done ✅ in SV2 Roadmap 🛣️ Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants