Skip to content

Commit

Permalink
Add explanation method to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
potomak committed Nov 10, 2014
1 parent 4a8c660 commit e222d10
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down

0 comments on commit e222d10

Please sign in to comment.