format

lsst.pex.config.history.format(config, name=None, writeSourceLine=True, prefix='', verbose=False)

Format the history record for a configuration, or a specific configuration field.

Parameters

configlsst.pex.config.Config

A configuration instance.

namestr, optional

The name of a configuration field to specifically format the history for. Otherwise the history of all configuration fields is printed.

writeSourceLinebool, optional

If True, prefix each printout line with the code filename and line number where the configuration event occurred. Default is True.

prefixstr, optional

A prefix for to add to each printout line. This prefix occurs first, even before any source line. The default is an empty string.

verbosebool, optional

Default is False.