unplugged-system/external/stardoc/test/testdata/function_basic_test/golden.md

A test that verifies basic user function documentation.

check_sources

check_sources(name, required_param, bool_param, srcs, string_param, int_param, dict_param,
              struct_param)

Runs some checks on the given source files.

This rule runs checks on a given set of source files. Use bazel build to run the check.

PARAMETERS

Name	Description	Default Value
name	A unique name for this rule.	none
required_param	Use your imagination.	none
bool_param	-	True
srcs	Source files to run the checks against.	[]
string_param	-	""
int_param	Your favorite number.	2
dict_param	-	{}
struct_param	-	struct(foo = "bar")

deprecated_do_not_use

deprecated_do_not_use()

This function is deprecated.

DEPRECATED

Use literally anything but this function.

returns_a_thing

returns_a_thing(name)

Returns a suffixed name.

PARAMETERS

Name	Description	Default Value
name	A unique name for this rule.	none

RETURNS

A suffixed version of the name.

undocumented_function

undocumented_function(a, b, c)

PARAMETERS

Name	Description	Default Value
a	-	none
b	-	none
c	-	none