You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Sep 15, 2021. It is now read-only.
defmy_macro(name, a, b=[], c="blah", **kwargs):
"""Mumble Args: name: The name a: An a b: List of b c: A string **kwargs: The <a href="https://docs.bazel.build/versions/master/be/common-definitions.html#common-attributes-tests">common attributes for tests</a>. """pass
You get generated markdown of:
## my_macro
<pre>
my_macro(<ahref="#my_macro-name">name</a>, <ahref="#my_macro-a">a</a>, <ahref="#my_macro-b">b</a>, <ahref="#my_macro-c">c</a>, <ahref="#my_macro-kwargs">kwargs</a>)
</pre>
Mumble
### Parameters
<tableclass="params-table">
<colgroup>
<col class="col-param" /><col class="col-description" />
</colgroup>
<tbody>
<tr id="my_macro-name"> <td><code>name</code></td> <td> required. <p> The name </p> </td></tr><tr id="my_macro-a"> <td><code>a</code></td> <td> required. <p> An a </p> </td></tr><tr id="my_macro-b"> <td><code>b</code></td> <td> required. <p> List of b </p> </td></tr><tr id="my_macro-c"> <td><code>c</code></td> <td> optional. default is <code>[]</code> <p> A string </p> </td></tr><tr id="my_macro-kwargs"> <td><code>kwargs</code></td> <td> optional. default is <code>"blah"</code> </td></tr>
</tbody>
</table>
Given:
You get generated markdown of:
Which renders to:
my_macro
Mumble
Parameters
name
The name
a
An a
b
List of b
c
[]
A string
kwargs
"blah"
What's worth noting here:
b
,c
, andkwargs
have shifted default values.b
is listed as required, but it has a default, like to do with the previous issue of displaying wrong defaults.kwargs
is missing its description.If you change the
**kwargs
in theArgs
section to justkwargs
, then description is displayed, but the other issues still apply.The text was updated successfully, but these errors were encountered: