rust-embedded / svd2rust

Generate Rust register maps (`struct`s) from SVD files
Apache License 2.0
675 stars 147 forks source link

move hidden into module #736

Closed burrbull closed 11 months ago

burrbull commented 11 months ago

cc @rust-embedded/tools

thejpster commented 11 months ago

v0.29: https://docs.rs/rp2040-pac/latest/rp2040_pac/

image

This patch:

image

thejpster commented 11 months ago

I like these changes. But I wonder if there's also scope to try and add some information to this page:

image

Edit:

Perhaps like:

image

burrbull commented 11 months ago

@thejpster Now it looks like изображение and изображение accordingly.

thejpster commented 11 months ago

Can we remove the '\n' between the lines? If they have '\n' between them I think they should be a bulleted list. Otherwise I think it should be one paragraph with no new-lines in it.

i.e.

You can read this register and get somemod::R. You can reset, write, write_with_zero this register and get somemod::W. You can also modify this register.

rather than

You can read this register and get somemod::R.
You can reset, write, write_with_zero this register and get somemod::W. 
You can also modify this register.

I also propose expanding on See API a little bit.

But these are minor things really. I really like these changes!

burrbull commented 11 months ago

done

thejpster commented 11 months ago

LGTM. Ship it.

thejpster commented 11 months ago

So good I managed to approve it twice :/