visibility API documentation

# visibility

Example where only the these children should be rendered:

- `__private_func_explicitly_public` and
- `public_func`

View Source

     1"""
     2Example where only the these children should be rendered:
     3 * `__private_func_explicitly_public` and
     4 * `public_func`
     5"""
     6
     7
     8class Undocumented:
     9    # Not shown because no docstring.
    10    pass
    11
    12
    13def public_func_marked_private():
    14    """
    15    This is a public method that's not shown because it's marked as @private.
    16    """
    17
    18
    19def _protected_func():
    20    """
    21    This is a protected method that's not shown because its name starts with _.
    22    """
    23
    24
    25def __private_func():
    26    """
    27    This is a private method that's not shown because its name starts with __.
    28    """
    29
    30
    31def __private_func_explicitly_public():
    32    """@public
    33    This is a private method that's shown because it is explicitly marked
    34    as public.
    35    """
    36
    37
    38def public_func():
    39    """
    40    This is another public method that's shown. It should show without additional
    41    whitespace above.
    42    """

def __private_func_explicitly_public(): View Source

    32def __private_func_explicitly_public():
    33    """@public
    34    This is a private method that's shown because it is explicitly marked
    35    as public.
    36    """

This is a private method that's shown because it is explicitly marked as public.

def public_func(): View Source

    39def public_func():
    40    """
    41    This is another public method that's shown. It should show without additional
    42    whitespace above.
    43    """

This is another public method that's shown. It should show without additional whitespace above.