pcdsdevices.utils.doc_format_decorator

pcdsdevices.utils.doc_format_decorator(**doc_fmts)

Decorator for substituting values into a docstring.

This is useful for cases where we want to include module constants in docstrings but we want the docstring to update automatically when we decide to change the constant.