Use tables to represent markdown parameters #265
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The parameters in the previous markdown view were pretty ugly, and did not show the
scope
parameters. I made is so parameters are now rendered in a markdown table instead.I ran into one hitch, I could not for the life of me make the cucumber spec pass. I manually ran:
be rspec app_spec.rb --require ./app.rb --format RspecApiDocumentation::ApiFormatter
Against a copy and pasted
app_spec.rb
andapp.rb
, and then diffed the outputs. They were exactly the same. I have no idea how to debug these cucumber tests, so I am probably doing it wrong. Any tips would be hugely appreciated 😄Thanks for maintaining such a useful project!
EDIT: Looks like the specs passed on CI! Must be a local bug.