human
Here's a good function header given the following:
I wrote the below code

    def deprecationDecorator(function):
        '\n                                Decorator    that    marks    C{function}    as    deprecated.\n                                '
        warningString = getDeprecationWarningString(function, version, None, replacement)
        @wraps(function)
        def deprecatedFunction(*args, **kwargs):
            warn(warningString, DeprecationWarning, stacklevel=2)
            return function(*args, **kwargs)
        _appendToDocstring(deprecatedFunction, _getDeprecationDocstring(version, replacement))
        deprecatedFunction.deprecatedVersion = version
        return deprecatedFunction
    return deprecationDecorator

What's a good function header?
assistant
#Here's a good function header.

def deprecated(version, replacement=None):