File tree Expand file tree Collapse file tree 2 files changed +3
-0
lines changed
lib/rspec_api_documentation/writers Expand file tree Collapse file tree 2 files changed +3
-0
lines changed Original file line number Diff line number Diff line change @@ -57,6 +57,7 @@ Feature: Generate Slate documentation from test examples
5757 end
5858
5959 resource 'Orders' do
60+ explanation "An Order represents an amount of money to be paid"
6061 get '/orders' do
6162 response_field :page, "Current page"
6263
@@ -216,6 +217,7 @@ Feature: Generate Slate documentation from test examples
216217
217218 ## Creating an order
218219
220+ An Order represents an amount of money to be paid
219221
220222 ### Request
221223
Original file line number Diff line number Diff line change @@ -26,6 +26,7 @@ def write
2626 IndexHelper . sections ( index . examples , @configuration ) . each do |section |
2727
2828 file . write "# #{ section [ :resource_name ] } \n \n "
29+ file . write "#{ section [ :resource_explanation ] } \n \n "
2930 section [ :examples ] . sort_by! ( &:description ) unless configuration . keep_source_order
3031
3132 section [ :examples ] . each do |example |
You can’t perform that action at this time.
0 commit comments