search

jam1garner / binrw

A Rust crate for helping parse and rebuild binary data using ✨macro magic✨.
https://binrw.rs
MIT License
585 stars 35 forks source link

Improve documentation for `BinrwNamedArgs` #76

Closed jam1garner closed 1 year ago

jam1garner commented 2 years ago

Similar to #75, errors relating to improperly passing arguments can be confusing to binrw beginners due to the fact all the named types currently have no/minimal documentation. The goal of such a documentation improvement would be to help give users the information needed to solve errors that would reference the trait.

csnover commented 1 year ago

Since I did apparently did some work on this sometime I will assume it is good enough for now.