API

package_name.greet

Module for greeting users.

This module provides functions to greet users.

Example

from package_name.greet import say_hello say_hello("Alice") 'Hello, Alice!'

say_goodbye(name)

Return a goodbye message.

Bids farewell to the user by name.

Example

say_goodbye("Alice") 'Goodbye, Alice!'

Source code in src/package_name/greet.py

def say_goodbye(name: str) -> str:
    """Return a goodbye message.

    Bids farewell to the user by name.

    Example:
        >>> say_goodbye("Alice")
        'Goodbye, Alice!'
    """
    return f"Goodbye, {name}!"

say_hello(name)

Return a greeting message.

Greets the user by name.

Example

say_hello("Alice") 'Hello, Alice!'

Parameters:

Name	Type	Description	Default
name	str	The name of the person to greet.	required

Returns: str: A message to say hello.

Source code in src/package_name/greet.py

def say_hello(name: str) -> str:
    """Return a greeting message.

    Greets the user by name.

    Example:
        >>> say_hello("Alice")
        'Hello, Alice!'

    Args:
        name (str): The name of the person to greet.
    Returns:
        str: A message to say hello.
    """
    return f"Hello, {name}!"