• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1"""A test that verifies documenting a multi-leveled namespace of functions with whitelist symbols.
2The whitelist symbols should cause everything in my_namespace to to be documented, but only a
3specific symbol in other_namespace to be documented."""
4
5def _min(integers):
6    """Returns the minimum of given elements."""
7    _ignore = [integers]  # @unused
8    return 42
9
10def _does_nothing():
11    """This function does nothing."""
12    pass
13
14my_namespace = struct(
15    dropped_field = "Note this field should not be documented",
16    min = _min,
17    math = struct(min = _min),
18)
19
20other_namespace = struct(
21    foo = struct(nothing = _does_nothing),
22    min = _min,
23)
24