Merge #33

33: Prepare 1.0.0 r=therealprof a=eldruin

Release depends on #30 

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

Author: bors[bot]

CHANGELOG.md

@@ -7,6 +7,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+## [v1.0.0] - 2020-07-07
+
 ### Changed
 
 - [breaking-change] The `unstable` feature and its code has been removed.
@@ -31,6 +33,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 Initial release
 
-[Unreleased]: https://github.com/rust-embedded/nb/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/rust-embedded/nb/compare/v1.0.0...HEAD
+[v1.0.0]: https://github.com/rust-embedded/nb/compare/v0.1.2...v1.0.0
 [v0.1.2]: https://github.com/rust-embedded/nb/compare/v0.1.1...v0.1.2
 [v0.1.1]: https://github.com/rust-embedded/nb/compare/v0.1.0...v0.1.1

Cargo.toml

@@ -9,5 +9,5 @@ repository = "https://github.com/rust-embedded/nb"
 homepage = "https://github.com/rust-embedded/nb"
 documentation = "https://docs.rs/nb"
 readme = "README.md"
-version = "0.1.2"
+version = "1.0.0" # remember to update html_root_url
 edition = "2018"

src/lib.rs

@@ -144,21 +144,24 @@
 //! Turn on an LED for one second and *then* loops back serial data.
 //!
 //! ```
+//! use core::convert::Infallible;
 //! use nb::block;
 //!
 //! use hal::{Led, Serial, Timer};
 //!
+//! # fn main() -> Result<(), Infallible> {
 //! // Turn the LED on for one second
 //! Led.on();
-//! block!(Timer.wait()).unwrap(); // NOTE(unwrap) E = Infallible
+//! block!(Timer.wait())?;
 //! Led.off();
 //!
 //! // Serial interface loopback
-//! # return;
+//! # return Ok(());
 //! loop {
-//!     let byte = block!(Serial.read()).unwrap();
-//!     block!(Serial.write(byte)).unwrap();
+//!     let byte = block!(Serial.read())?;
+//!     block!(Serial.write(byte))?;
 //! }
+//! # }
 //!
 //! # mod hal {
 //! #   use nb;
@@ -170,8 +173,8 @@
 //! #   }
 //! #   pub struct Serial;
 //! #   impl Serial {
-//! #       pub fn read(&self) -> nb::Result<u8, ()> { Ok(0) }
-//! #       pub fn write(&self, _: u8) -> nb::Result<(), ()> { Ok(()) }
+//! #       pub fn read(&self) -> nb::Result<u8, Infallible> { Ok(0) }
+//! #       pub fn write(&self, _: u8) -> nb::Result<(), Infallible> { Ok(()) }
 //! #   }
 //! #   pub struct Timer;
 //! #   impl Timer {
@@ -181,6 +184,7 @@
 //! ```
 
 #![no_std]
+#![doc(html_root_url = "https://docs.rs/nb/1.0.0")]
 
 use core::fmt;