benbjohnson / immutable

Immutable collections for Go
MIT License
713 stars 32 forks source link

Remove references to []byte keys in README #24

Closed banks closed 2 years ago

banks commented 2 years ago

23 added generic support (which is awesome) but noted the breaking change about no longer supporting []byte keys due to the Ordered constraint.

Ideally, this library would continue to support []byte keys and use a custom interface to constrain key types instead. But until that happens, the README right now is a bit surprising as it talks explicitly about supporting []byte keys still but they are actually a compile error!

Here's a drive-by fix for the README for now - I think I caught all the incorrect statements.

benbjohnson commented 2 years ago

Good catch, @banks! I agree that []byte support would be nice. I haven't had any time to dig into the Go generics stuff but I'm open to a PR if anyone wants to tackle it.