Info about option value type in generated docs (#461)

snowflakedb · Oct 10, 2023 · fb5442f · fb5442f
1 parent 6e87428
commit fb5442f
Showing 1 changed file with 2 additions and 2 deletions.
diff --git a/src/snowcli/app/dev/docs/templates/usage.rst.jinja2 b/src/snowcli/app/dev/docs/templates/usage.rst.jinja2
@@ -18,7 +18,7 @@ Arguments
 
 {%- if arguments %}
 {% for param in arguments %}
-:samp:`{% for p in param.opts %}{{ p }}{{ ", " if not loop.last }}{% endfor %} {{ '{' }}{{ param.name }}{{ '}' }}`
+:samp:`{% for p in param.opts %}{{ p }}{{ ", " if not loop.last }}{% endfor %} {{ '{' }}{{ param.make_metavar() }}{{ '}' }}`
 {% if param.help %}{{ "  " + param.help | replace("`", "``") }}{% if param.help[-1] != '.' %}.{% endif %}{% else %}  TBD{% endif %}
 {% endfor %}
 {% else %}
@@ -32,7 +32,7 @@ Options
 
 {%- if options %}
 {% for param in options if not param.hidden %}
-:samp:`{% for p in param.opts %}{{ p }}{{ ", " if not loop.last }}{% endfor %}{% if not param.is_flag %} {{ '{' }}{{ param.name }}{{ '}' }}{% endif %}`
+:samp:`{% for p in param.opts %}{{ p }}{{ ", " if not loop.last }}{% endfor %}{% if not param.is_flag %} {{ '{' }}{{ param.make_metavar() }}{{ '}' }}{% endif %}`
 {% if param.help %}{{ "  " + param.help | replace("`", "``") }}{% if param.help[-1] != '.' %}.{% endif %}{% else %}  TBD{% endif %}
 {% endfor %}
 {% else %}