A test that verifies basic user function documentation.

check_sources

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

This function is deprecated.

DEPRECATED

Use literally anything but this function.

param_doc_multiline

Has a complex parameter.

PARAMETERS

Name	Description	Default Value
complex	A parameter with some non-obvious behavior. For example, it does things that require multiple paragraphs to explain. Note: we should preserve the nested indent in the following code: { “key”: “value” }	none

returns_a_thing

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

PARAMETERS

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