Description
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.
Metadata
Metadata
Assignees
Type
Projects
Status
Done
Activity
Enabling doc_auto_cfg to show feature flags
Add lz4 compression support
Add lz4 compression support
ecton commentedon Apr 4, 2022
This is in the prerelease of 1.60.
Namespaced feature flags + Increased MSRV (1.60)
2 remaining items