While working on getting doc_cfg working, I ran into issues with several ways that our documentation was laid out. However, the biggest issue is that the complex nature of our feature flags is just not workable with doc_cfg as-is. I'm still going to be pushing the changes to enable it anyways, as having note of what items are behind a feature flag is useful enough even if users temporarily need to refer to another location for a list of the feature flags.
With the recent stabilization of namespaced and weak dependency features, we will be able to refactor the feature flags such that "encryption" works at the bonsaidb level, without needing specific versions like we currently do (server-encryption, local-encryption). This also means that the resuls of doc_auto_cfg will line up perfectly.
The only thing this issue needs is time for the stabilized feature to be released. In the meantime I wanted to make a note of it, as users may be a little confused by the feature flag names not lining up perfectly depending on how they're including the crates.
ecton
commented
2 years ago
While working on getting
doc_cfgworking, I ran into issues with several ways that our documentation was laid out. However, the biggest issue is that the complex nature of our feature flags is just not workable with doc_cfg as-is. I'm still going to be pushing the changes to enable it anyways, as having note of what items are behind a feature flag is useful enough even if users temporarily need to refer to another location for a list of the feature flags.With the recent stabilization of namespaced and weak dependency features, we will be able to refactor the feature flags such that "encryption" works at the
bonsaidblevel, without needing specific versions like we currently do (server-encryption,local-encryption). This also means that the resuls ofdoc_auto_cfgwill line up perfectly.The only thing this issue needs is time for the stabilized feature to be released. In the meantime I wanted to make a note of it, as users may be a little confused by the feature flag names not lining up perfectly depending on how they're including the crates.