def metric_description()

in src/smclarify/bias/metrics/common.py [0:0]

• 4 lines of code
• 2 McCabe index (conditional complexity)

def metric_description(metric: Callable[..., float]) -> str:
    """
    fetch metric description from doc strings
    :param metric: metric callable function
    :return: short description of metric
    """
    if not metric.__doc__:
        logger.exception(f"Description is not found for the registered metric: {metric}")
    return metric.__doc__.lstrip().split("\n")[0]  # type: ignore