snap_html.example

We use this file as an example for some module.

View Source
"""We use this file as an example for some module."""


def hello(name: str) -> str:
    """Just an greetings example.

    Args:
        name (str): Name to greet.

    Returns:
        str: greeting message

    Examples:
        .. code:: python

            >>> hello("Roman")
            'Hello Roman!'
    """
    return f"Hello {name}!"


__all__ = ["hello"]
def hello(name: str) -> str:
View Source
def hello(name: str) -> str:
    """Just an greetings example.

    Args:
        name (str): Name to greet.

    Returns:
        str: greeting message

    Examples:
        .. code:: python

            >>> hello("Roman")
            'Hello Roman!'
    """
    return f"Hello {name}!"

Just an greetings example.

Args: name (str): Name to greet.

Returns: str: greeting message

Examples: .. code:: python

    >>> hello("Roman")
    'Hello Roman!'