search

parallelsystems / bit-struct

ergonomic bitfields in Rust
12 stars 3 forks source link

Consider having a exemple in the doc #3

Open Stargateur opened 2 years ago

Stargateur commented 2 years ago

The readme contains a full example of use case, it's would be nice to have an compiled example of what item are generated in the doc, like https://docs.rs/snafu/0.6.10/snafu/guide/examples/basic/index.html for example.

This is more easy to understand what macro do for the user.

andrewgazelka commented 2 years ago

Hello,

I hadn't thought of this, and I think it is a good point. On first thought, having a guide folder in src seems a little bit messy, but since docs can't be generated for the tests or example folder, I think this is the best option. I'll try doing this.