maestrowf
maestrowf copied to clipboard
documentation improvements
The documentation for configure_study states that "the method is used for going through and actually acquiring each dependency, substituting variables, sources and labels".
This doesn't seem to be true now:
def configure_study(self, submission_attempts=1, restart_limit=1,
throttle=0, use_tmp=False, hash_ws=False,
dry_run=False):
"""Perform initial configuration of a study..."""
self._submission_attempts = submission_attempts
self._restart_limit = restart_limit
self._submission_throttle = throttle
self._use_tmp = use_tmp
self._hash_ws = hash_ws
self._dry_run = dry_run
LOGGER.info(
"\n------------------------------------------\n"
"Submission attempts = %d\n"
"Submission restart limit = %d\n"
"Submission throttle limit = %d\n"
"Use temporary directory = %s\n"
"Hash workspaces = %s\n"
"Dry run enabled = %s\n"
"Output path = %s\n"
"------------------------------------------",
submission_attempts, restart_limit, throttle,
use_tmp, hash_ws, dry_run, self._out_path
)
self.is_configured = True