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

1.7 KiB
Executable File

A test that verifies documenting a namespace of functions.

my_namespace.assert_non_empty

my_namespace.assert_non_empty(some_list, other_list)

Asserts the two given lists are not empty.

PARAMETERS

Name Description Default Value
some_list The first list none
other_list The second list none

my_namespace.min

my_namespace.min(integers)

Returns the minimum of given elements.

PARAMETERS

Name Description Default Value
integers A list of integers. Must not be empty. none

RETURNS

The minimum integer in the given list.

my_namespace.join_strings

my_namespace.join_strings(strings, delimiter)

Joins the given strings with a delimiter.

PARAMETERS

Name Description Default Value
strings A list of strings to join. none
delimiter The delimiter to use ", "

RETURNS

The joined string.