Add deprecated attributes modelled off zstd.h definitions #259
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests.
Flags with carried forward coverage won't be shown. Click here to find out more.
... and 4 files with indirect coverage changes 🚀 New features to boost your workflow:
|
|
|
||
| #[deprecated( | ||
| since = "1.5.6", | ||
| note = "For debugging only, will be replaced by [`ZSTD_extractSequences`]" |
There was a problem hiding this comment.
the rustdoc link does not work in this position currently.
I kind of think that it should though, so this is just a note.
There was a problem hiding this comment.
I actually implemented this, so with nightly this renders correctly now (and that will make it to stable in ~12 weeks)
| } | ||
|
|
||
| #[deprecated( | ||
| since = "1.5.6", |
There was a problem hiding this comment.
These versions are zstd versions, not versions of this crate. It kind of looks fine though, and it seems like a good way to preserve and present this information.
There was a problem hiding this comment.
actually @bjorn3 would it be better to make this something like 0.0.0+1.5.6? We'll probably never release that version, but currently it may look like we're deprecating symbols in future releases which could be confusing.
|
I think we should just blanket allow the use of deprecated functions in our test crate. Also this needs a rebase. |
|
Rebased and allowed deprecated functions in tests/fuzzers |
2 participants
Using the definitions in
zstd.h, marked the relevant functions as deprecated in the code and where possible added thesinceandnotetags.