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

Enabling doc_auto_cfg to show feature flags #179

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Enabling doc_auto_cfg to show feature flags #179

wants to merge 1 commit into from

Conversation

ecton
Copy link
Member

@ecton ecton commented Feb 6, 2022

This isn't perfect, but it's better than not having feature flags
showing up at all. #178 explains the vision for where this will end-up
after namespaced feature flags are released, and #174 can introduce a
table of feature flags for each crate and link to #178.

This isn't perfect, but it's better than not having feature flags
showing up at all. #178 explains the vision for where this will end-up
after namespaced feature flags are released, and #174 can introduce a
table of feature flags for each crate and link to #178.
@ecton ecton added the blocked This issue can't be resolved due to a dependency label Feb 6, 2022
@ecton ecton marked this pull request as draft February 6, 2022 04:39
@ecton
Copy link
Member Author

ecton commented Feb 6, 2022

Well, I've decided to hold off on merging this. CI just needs to be swapped to nightly, silly oversight on my part.

The conundrum is this: The bonsaidb omnibus crate re-exports dependent crates based on what feature flags are activated. Each of those crates can be used independently, giving us a whole mess of feature flags which will be resolved by #178 eventually.

The exports are currently #[doc(inline)], which makes it so that when you go to https://docs.rs/bonsaidb and search for something, you can immediately find it across the entire omnibus crate. Currently this yields doc attributes being rendered at the exported location correctly, but the inlined items all omit their feature flag annotations (rustlang/rust#88743),

I was originally going to merge this with inlining disabled, but the documentation search feature is too critical. I'll probably go through and manually add notes in the documentation for the short term, as tedious as that will be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked This issue can't be resolved due to a dependency
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant