Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: clarify zerocopy::byteorder::network_endian is an alias for zerocopy::byteorder::big_endian #2033

Open
lolbinarycat opened this issue Nov 7, 2024 · 2 comments
Assignees

Comments

@lolbinarycat
Copy link

this seems obvious, and digging through the source code reveals it is true, but it would be nice to have the module docs say it explicitly.

@jswrenn
Copy link
Collaborator

jswrenn commented Nov 7, 2024

We already document this on NetworkEndian; where do you think additional documentation would be helpful?

Image

@lolbinarycat
Copy link
Author

either after this sentence:

Type aliases are provided for common byte orders in the big_endian, little_endian, network_endian, and native_endian submodules.

or in the zerocopy::byteorder::network_endian module itself.

i know it's on the enum, but it's pretty easy to skip looking at the enum and go straight to the convenience modules.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants