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

1.8 KiB
Executable File

A test that verifies documenting a multi-leveled namespace of functions.

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.math.min

my_namespace.math.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.foo.bar.baz

my_namespace.foo.bar.baz()

This function does nothing.

my_namespace.one.two.min

my_namespace.one.two.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.one.three.does_nothing

my_namespace.one.three.does_nothing()

This function does nothing.