Skip to content

Commit c41b803

Browse files
authored
Merge pull request #265 from ianks/pretty-markdown-parameters-table
Use tables to represent markdown parameters
2 parents 595a8a3 + f808b51 commit c41b803

File tree

3 files changed

+15
-11
lines changed

3 files changed

+15
-11
lines changed

features/markdown_documentation.feature

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -229,14 +229,11 @@ Feature: Generate Markdown documentation from test examples
229229
230230
### Parameters
231231
232-
Name : name *- required -*
233-
Description : Name of order
234-
235-
Name : amount *- required -*
236-
Description : Amount paid
237-
238-
Name : description
239-
Description : Some comments on the order
232+
| Name | Description | Required | Scope |
233+
|------|-------------|----------|-------|
234+
| name | Name of order | true | |
235+
| amount | Amount paid | true | |
236+
| description | Some comments on the order | false | |
240237
241238
### Request
242239

lib/rspec_api_documentation/views/markdown_example.rb

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,12 @@ def initialize(example, configuration)
88
self.template_name = "rspec_api_documentation/markdown_example"
99
end
1010

11+
def parameters
12+
super.each do |parameter|
13+
parameter[:required] = parameter[:required] ? 'true' : 'false'
14+
end
15+
end
16+
1117
def extension
1218
EXTENSION
1319
end

templates/rspec_api_documentation/markdown_example.mustache

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@
1414
{{# has_parameters? }}
1515

1616
### Parameters
17-
{{# parameters }}
1817

19-
Name : {{ name }}{{# required }} *- required -*{{/ required }}
20-
Description : {{ description }}
18+
| Name | Description | Required | Scope |
19+
|------|-------------|----------|-------|
20+
{{# parameters }}
21+
| {{ name }} | {{ description }} | {{ required }} | {{ scope }} |
2122
{{/ parameters }}
2223

2324
{{/ has_parameters? }}

0 commit comments

Comments
 (0)