You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It's possible to document the features in the Cargo.toml and then use https://docs.rs/document-features/latest/document_features/ to make that appear in the crate docs, which helps ensure the feature docs are up to date by being just above the relevant feature declaration
Hi
The
zstd
crate currently has thelegacy
,arrays
,zdict_builder
features enabled by default:zstd-rs/Cargo.toml
Lines 31 to 32 in e470f00
I was curious what impact using
default-features = false
would have, however, could not find any docs on those default features (or most of the optional features) on either of:https://docs.rs/zstd/latest/zstd/
https://github.com/gyscos/zstd-rs/blob/main/Readme.md
For the features that are passed to
zstd-safe
, I also tried checking here for feature docs:https://docs.rs/zstd-safe/latest/zstd_safe/
https://github.com/gyscos/zstd-rs/blob/main/zstd-safe/Readme.md
There are some inline code comments in
zstd-sys
'sCargo.toml
:zstd-rs/zstd-safe/zstd-sys/Cargo.toml
Lines 68 to 78 in e470f00
...however, these are quite brief, don't cover all of the features present in the top-level
zstd
crate, and were less obvious to find.Some docs on the module rustdocs and/or the README would help with discoverability :-)
The text was updated successfully, but these errors were encountered: