xref: /aosp_15_r20/external/bazelbuild-rules_python/sphinxdocs/tests/sphinx_stardoc/function.md (revision 60517a1edbc8ecf509223e9af94a7adec7d736b8)
1:::{default-domain} bzl
2:::
3
4:::{bzl:currentfile} //lang:function.bzl
5:::
6
7
8# Function
9
10Module documentation
11
12::::::{bzl:function} myfunc(foo, bar=False, baz=[]) -> FooObj
13
14This is a bazel function.
15
16:arg arg1:
17  {default-value}`99`
18  {type}`bool | int`
19  arg1 doc
20
21:arg arg2:
22  {default-value}`True`
23  {type}`dict[str, str]` my arg2 doc
24
25  and a second paragraph of text here
26:arg arg3:
27  {default-value}`"arg3default"`
28  {type}`list[int]`
29  my arg3 doc
30:arg arg4:
31  my arg4 doc
32
33:returns:
34  {bzl:return-type}`list | int`
35  description
36
37:::{deprecated} unspecified
38
39Some doc about the deprecation
40:::
41
42::::::
43
44:::{bzl:function} mylongfunc(arg1, arg2, arg3, arg4, arg5, arg6, arg7, arg8, arg9)
45
46:::
47