documentation improvements
Open
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 161
- Forks
- 49
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with maestrowf/datastructures/core/study.py at configure_study and compare its documentation with the implementation shown in the issue. Update the description so it accurately reflects the method's current behavior; done means the documentation no longer claims it acquires dependencies or substitutes variables, sources, and labels.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100