Bump version to 1.0.0-beta.3 + little doc fixes

Author: twickham

Cargo.toml

@@ -1,7 +1,7 @@
 [package]
 name = "rspec"
 description = "Write Rspec-like tests with stable rust"
-version = "1.0.0-beta.2"
+version = "1.0.0-beta.3"
 authors = ["Thomas Wickham <[email protected]>"]
 license = "MPL-2.0"
 homepage = "https://mackwic.github.io/rspec"

README.md

@@ -45,11 +45,11 @@ fn test_add() {
     rdescribe("add", |ctx| {
         ctx.describe("0 <= x + y <= u32::MAX", |ctx| {
             ctx.it("2 + 4 = 6", || {
-                assert_eq!(6, add(2, 4)); Ok(())
+                assert_eq!(6, add(2, 4))
             });
 
             ctx.it("4 + 4 = 8", || {
-                assert_eq!(8, add(4, 4)); Ok(())
+                assert_eq!(8, add(4, 4))
             });
         });
 
@@ -58,7 +58,6 @@ fn test_add() {
             assert_eq!(add(4, 1), add(1, 4));
             assert_eq!(add(4, 5), add(5, 4));
             assert_eq!(add(12, 1), add(1, 12));
-            Ok(())
         });
     });
 }
@@ -109,6 +108,10 @@ pub fn main() {
 
 ```
 
+*Note:*
+- `describe` has 4 aliases: `specify`, `context`, `given`, and `when`
+- `it` has 2 aliases: `example`, and `then`
+
 Again, you can see complete examples in the [`examples/`](https://github.com/mackwic/rspec/tree/master/examples) directory.
 
 The last stable documentation is available for consultation at

examples/given_when_then.rs

@@ -6,6 +6,7 @@ use std::io;
 pub fn main() {
     let stdout = &mut io::stdout();
     let mut formatter = rspec::formatter::Simple::new(stdout);
+
     let mut runner = describe("rspec allows for Cucumber-style BDD testing", |ctx| {
         ctx.given("A known state of the subject", |ctx| {
             ctx.when("a key action is performed", |ctx| {
@@ -15,6 +16,7 @@ pub fn main() {
             });
         });
     });
+
     runner.add_event_handler(&mut formatter);
     runner.run().unwrap();
 }

src/context.rs

@@ -20,13 +20,13 @@
 //!     });
 //!
 //!     describe("Context::specify", |ctx| {
-//!         ctx.specify("can used as a drop-in alternative to `Context::describe`", |ctx| {
+//!         ctx.specify("can be used as a drop-in alternative to `Context::describe`", |ctx| {
 //!             // ...
 //!         });
 //!     });
 //!
 //!     describe("Context::context", |ctx| {
-//!         ctx.context("can used as a drop-in alternative to `Context::describe`", |ctx| {
+//!         ctx.context("can be used as a drop-in alternative to `Context::describe`", |ctx| {
 //!             // ...
 //!         });
 //!     });
@@ -136,7 +136,7 @@ impl<'a> Context<'a> {
         self.tests.push(Testable::Describe(name.into(), child))
     }
 
-    /// Interchangeable alternative name for [`describe`](struct.Context.html#method.describe).
+    /// Alias for [`describe`](struct.Context.html#method.describe).
     ///
     /// See [`describe`](struct.Context.html#method.describe) for more info.
     pub fn specify<S, F>(&mut self, name: S, body: F)
@@ -147,7 +147,7 @@ impl<'a> Context<'a> {
         self.describe(name, body)
     }
 
-    /// Interchangeable alternative name for [`describe`](struct.Context.html#method.describe).
+    /// Alias for [`describe`](struct.Context.html#method.describe).
     ///
     /// See [`describe`](struct.Context.html#method.describe) for more info.
     pub fn context<S, F>(&mut self, name: S, body: F)
@@ -158,7 +158,7 @@ impl<'a> Context<'a> {
         self.describe(name, body)
     }
 
-    /// Interchangeable alternative name for [`describe`](struct.Context.html#method.describe).
+    /// Alias for [`describe`](struct.Context.html#method.describe).
     ///
     /// See [`describe`](struct.Context.html#method.describe) for more info.
     pub fn given<S, F>(&mut self, name: S, body: F)
@@ -170,7 +170,7 @@ impl<'a> Context<'a> {
         self.describe(prefixed_name, body)
     }
 
-    /// Interchangeable alternative name for [`describe`](struct.Context.html#method.describe).
+    /// Alias for [`describe`](struct.Context.html#method.describe).
     ///
     /// See [`describe`](struct.Context.html#method.describe) for more info.
     pub fn when<S, F>(&mut self, name: S, body: F)
@@ -219,7 +219,7 @@ impl<'a> Context<'a> {
         self.tests.push(Testable::Test(name.into(), Box::new(f)))
     }
 
-    /// Interchangeable alternative name for [`it`](struct.Context.html#method.it).
+    /// Alias for [`it`](struct.Context.html#method.it).
     ///
     /// See [`it`](struct.Context.html#method.it) for more info.
     pub fn example<S, F, T>(&mut self, name: S, body: F)
@@ -231,7 +231,7 @@ impl<'a> Context<'a> {
         self.it(name, body)
     }
 
-    /// Interchangeable alternative name for [`it`](struct.Context.html#method.it).
+    /// Alias for [`it`](struct.Context.html#method.it).
     ///
     /// See [`it`](struct.Context.html#method.it) for more info.
     pub fn then<S, F, T>(&mut self, name: S, body: F)