Merge #305

305: Fix serial doctest + require passing tests on bors r=therealprof a=eldruin

This escaped CI somehow in #300.
Thanks to `@adamgreig` for his help in figuring this out.
Now passing the tests is also a requirement for bors.

Co-authored-by: Diego Barrios Romero <[email protected]>
Co-authored-by: Daniel Egger <[email protected]>

Author: 3 people

.github/bors.toml

@@ -6,5 +6,7 @@ status = [
   "ci-linux (stable, thumbv6m-none-eabi)",
   "ci-linux (stable, thumbv7m-none-eabi)",
   "ci-linux (1.35.0, x86_64-unknown-linux-gnu)",
+  "ci-linux-test (stable)",
+  "ci-linux-test (1.36.0, x86_64-unknown-linux-gnu)",
   "fmt",
 ]

.github/workflows/test.yml

@@ -9,7 +9,7 @@ env:
   RUSTFLAGS: '--deny warnings'
 
 jobs:
-  ci-linux:
+  ci-linux-test:
     runs-on: ubuntu-latest
     strategy:
       matrix:

src/lib.rs

@@ -155,7 +155,7 @@
 //!
 //!     fn read(&mut self) -> nb::Result<u8, Error> {
 //!         // read the status register
-//!         let isr = self.usart.isr.read();
+//!         let isr = self.usart.sr.read();
 //!
 //!         if isr.ore().bit_is_set() {
 //!             // Error: Buffer overrun
@@ -164,7 +164,7 @@
 //!         // omitted: checks for other errors
 //!         else if isr.rxne().bit_is_set() {
 //!             // Data available: read the data register
-//!             Ok(self.usart.rdr.read().bits() as u8)
+//!             Ok(self.usart.dr.read().bits() as u8)
 //!         } else {
 //!             // No data available yet
 //!             Err(nb::Error::WouldBlock)