From e222d10668a494d149a22d5d9786849b92545a47 Mon Sep 17 00:00:00 2001 From: Giovanni Cappellotto Date: Mon, 10 Nov 2014 11:28:10 +0100 Subject: [PATCH] Add explanation method to documentation --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index c08ebcc9..ef1fc2f5 100644 --- a/README.md +++ b/README.md @@ -342,6 +342,22 @@ resource "Orders" do end ``` +#### explanation + +This method takes a string representing a detailed explanation of the example. + +```ruby +resource "Orders" do + post "/orders" do + example "Creating an order" do + explanation "This method creates a new order." + do_request + # make assertions + end + end +end +``` + #### header This method takes the header name and value. The value can be a string or a symbol. If it is a symbol it will `send` the symbol, allowing you to `let` header values.