Skip to content

Commit 81f37bc

Browse files
committed
Merge pull request #172 from potomak/update-readme
Add explanation method to documentation
2 parents 3506f2e + e222d10 commit 81f37bc

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,22 @@ resource "Orders" do
342342
end
343343
```
344344

345+
#### explanation
346+
347+
This method takes a string representing a detailed explanation of the example.
348+
349+
```ruby
350+
resource "Orders" do
351+
post "/orders" do
352+
example "Creating an order" do
353+
explanation "This method creates a new order."
354+
do_request
355+
# make assertions
356+
end
357+
end
358+
end
359+
```
360+
345361
#### header
346362

347363
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.

0 commit comments

Comments
 (0)