hackndev / zinc

The bare metal stack for rust
zinc.rs
Apache License 2.0
1k stars 100 forks source link

tiva_c docs should ignore only actual pin instantiations #404

Closed mcoffin closed 7 years ago

mcoffin commented 7 years ago

Fix #373

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 85.657% when pulling 0bdefeb361c2aa47885bbe393fac7b4135c414f3 on mcoffin:missing-tiva-docs#373 into e68f861d0471272698e3fdd78b743b8a4d352b18 on hackndev:master.

coveralls commented 7 years ago

Coverage Status

Coverage remained the same at 85.657% when pulling 0bdefeb361c2aa47885bbe393fac7b4135c414f3 on mcoffin:missing-tiva-docs#373 into e68f861d0471272698e3fdd78b743b8a4d352b18 on hackndev:master.

jamwaffles commented 7 years ago

Ironically, this is PR 404 so make of that what you will...

A quick skim over the commits and this looks much better than my kludgy solution in #404. Are there plans to add docs to some/all of the parts touched in this PR? Most of the parts are pretty self explanatory so actual docs might not be necessary. What about examples and "this thing exists" sections in the docs?

farcaller commented 7 years ago

Are there plans to add docs to some/all of the parts touched in this PR?

The better idea is to migrate code to new ioregs and define docs there. Although there's no support for repeated registers yet.