API reference

seismogen package.

example_function(argument, keyword_argument='default')

Concatenate string arguments - an example function docstring.

Parameters:

Name	Type	Description	Default
argument	str	An argument.	required
keyword_argument	str	A keyword argument with a default value.	'default'

Returns:

Type	Description
str	The concatenation of argument and keyword_argument.

Source code in src/seismogen/__init__.py

def example_function(argument: str, keyword_argument: str = "default") -> str:
    """
    Concatenate string arguments - an example function docstring.

    Args:
        argument: An argument.
        keyword_argument: A keyword argument with a default value.

    Returns:
        The concatenation of `argument` and `keyword_argument`.

    """
    return argument + keyword_argument