pyiron_base.jobs.job.extension.jobstatus.format_docstring_with_statuses#
- pyiron_base.jobs.job.extension.jobstatus.format_docstring_with_statuses(n_tabs: int = 1) callable[source]#
Replaces a ‘{}’ in the decorated object’s docstring with the documentation for all possible job status.
The intent here is to have a single place where all status-value documentation can be maintained.
- Parameters:
n_tabs (int) – The number of tabs preceding each status type. (Default is one)