Skip to content

Commit 560c3bd

Browse files
authored
Merge pull request #379 from cookpad/slate-resource-explanation
Slate resource explanation
2 parents 35bac0b + 866c3ed commit 560c3bd

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

features/slate_documentation.feature

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff 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
@@ -214,6 +215,8 @@ Feature: Generate Slate documentation from test examples
214215
"""
215216
# Orders
216217
218+
An Order represents an amount of money to be paid
219+
217220
## Creating an order
218221
219222

lib/rspec_api_documentation/writers/slate_writer.rb

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@ def write
2424
file.write markup_index_class.new(index, configuration).render
2525

2626
IndexHelper.sections(index.examples, @configuration).each do |section|
27-
2827
file.write "# #{section[:resource_name]}\n\n"
29-
section[:examples].sort_by!(&:description) unless configuration.keep_source_order
28+
file.write "#{section[:resource_explanation]}\n\n"
3029

3130
section[:examples].each do |example|
3231
markup_example = markup_example_class.new(example, configuration)

0 commit comments

Comments
 (0)