Open luizirber opened 4 years ago
Markdown version for the checklist in https://raw.githubusercontent.com/rust-lang/api-guidelines/master/src/checklist.md:
as_
, to_
, into_
conventions ([C-CONV])iter
, iter_mut
, into_iter
([C-ITER])Copy
, Clone
, Eq
, PartialEq
, Ord
, PartialOrd
, Hash
, Debug
,
Display
, Default
From
, AsRef
, AsMut
([C-CONV-TRAITS])FromIterator
and Extend
([C-COLLECT])Serialize
, Deserialize
([C-SERDE])Send
and Sync
where possible ([C-SEND-SYNC])Hex
, Octal
, Binary
formatting ([C-NUM-FMT])R: Read
and W: Write
by value ([C-RW-VALUE])?
, not try!
, not unwrap
([C-QUESTION-MARK])Deref
and DerefMut
([C-DEREF])bool
or Option
([C-CUSTOM-TYPE])bitflags
, not enums ([C-BITFLAG])Debug
([C-DEBUG])Debug
representation is never empty ([C-DEBUG-NONEMPTY])is this something we want to block a 4.0 release on, @luizirber?
Not a blocker (doesn't change anything in the Python API). It would be nice but it is quite a bit of work :grimacing:
With the changes in 4.0 there is more consolidation in the MinHash API, so it is probably a good time to also be more serious about versioning of the
core
crate.TODO:
experimental
feature and put anything that is not needed for FFI/Python compat (like the Index implementations for SBTs and BIGSI).experimental
is opt-in, and there are no stability guarantees.