Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Commit

Permalink
Add label to denote optional arguments
Browse files Browse the repository at this point in the history
Prior to this change, the rendered docs didn't indicate which arguments
were optional. This differed from the behavior on atom.io. See

https://user-images.githubusercontent.com/2988/60625840-f1550380-9db6-11e9-821c-d75d31511e15.png

This commit resolves that discrepancy. Optional arguments will now have
an "optional" badge.
  • Loading branch information
jasonrudolph committed Jul 15, 2019
1 parent 60234aa commit 5a0f390
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions lib/filters/api_json_filter.rb
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ def argument_row(arg, level)
#{markdown("`#{arg["name"]}`")}
</td>
<td>
#{arg["isOptional"] ? '<span class="optional">optional</span>' : ''}
#{markdown(arg["description"])}
</td>
</tr>
Expand Down

0 comments on commit 5a0f390

Please sign in to comment.