Improve SPI, RCC and AFIO documentation #233

TheZoq2 · 2020-06-21T09:59:48Z

The lack of documentation for how to get a hold of the Rcc and Afio structs has bothered me for a while. This fixes that, along with adding some top level documentation to the SPI module

src/afio.rs

therealprof · 2020-06-21T13:43:35Z

src/afio.rs

+/// Aquired by calling [constrain](trait.AfioExt.html#constrain) on the [AFIO
+/// registers](../pac/struct.AFIO.html)
+///
+/// ```rust


rust is superfluous here as it is automatically assumed, but doc tests for embedded should probably at least feature the no_run attribute (if they can be compiled but will not run on the host) or even ignore if the example cannot compile due to ficticious code.

Oh right, I almost forgot doctests are a thing. It would be nice to them where possible, though I feel like it might require a fair amount of extra code in a lot of docstrings.

Since it seems to be kind of difficult to run doctests right now, I'd say we should merge this, release a new version to get updated docs on docs.rs, and then sort out doctests later.

Any objections?

There's a conflict though.

Oh right, there are always changelog problems :) I'll merge #183 then sort these out and merge this

src/rcc.rs

…and flash