google / zerocopy

https://discord.gg/MAvWH2R6zk
Apache License 2.0
1.63k stars 105 forks source link

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

Open lolbinarycat opened 1 month ago

lolbinarycat commented 1 month ago

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 commented 1 month ago

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

Image

lolbinarycat commented 1 month ago

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.