google / google/zerocopy

Add documentation and a test for depending on zerocopy and zerocopy-derive separately

Open
#539 0 comments 0 reactions 0 assignees View on GitHub
compatibility-nonbreaking
Dominant language
Rust
Stars
2.6k
Forks
179
Avg merge
1d 19h
Merged PRs (30d)
29

Description

We allow users to depend on zerocopy and, instead of enabling the `derive` feature, depend on zerocopy-derive directly. As demonstrated by [this comment](https://github.com/google/zerocopy/pull/505#discussion_r1370189353), doing this can have unexpected and bad ergonomics.

We should:
- add a test that makes sure the ergonomics of this use case are acceptable
- if we can't make the ergonomics as good as those of the `derive` feature, document what users must do in this case

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.