ibm_aigov_facts_client.utils.doc_annotations module

experimental(api_or_type: callable | str)

Decorator / decorator creator for marking APIs experimental in the docstring. :param api: An API to mark, or an API typestring for which to generate a decorator. :return: Decorated API (if a api_or_type is an API) or a function that decorates

the specified API type (if api_or_type is a typestring).

deprecated(alternative=None, since=None, impact=None, reason=None)

Decorator for marking APIs deprecated in the docstring. :param func: A function to mark :returns Decorated function.

keyword_only(func)

A decorator that forces keyword arguments in the wrapped method.

deprecated_param(alternative=None, since=None, impact=None, deprecated_args=None)

Decorator for marking APIs params deprecated in the docstring. :param func: A function to mark :returns Decorated function.