[bug] documentation of `wait` parameter for `SingleNodeExecutor` misleading?
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 77
- Forks
- 7
- Avg merge
- 10h 32m
- Merged PRs (30d)
- 12
Description
From the docs of SingleNodeExecutor https://github.com/pyiron/executorlib/blob/3ef0ba9b40c16d3f2f28e30cb67de399517dbba1/src/executorlib/executor/single.py#L64 I expected it to support the wait parameter
However, when I try to use it, I hit
https://github.com/pyiron/executorlib/blob/3ef0ba9b40c16d3f2f28e30cb67de399517dbba1/src/executorlib/standalone/inputcheck.py#L28
Contributor guide
No contributing guide indexed for this repository
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 the SingleNodeExecutor documentation in src/executorlib/executor/single.py at the linked section, then inspect the wait handling in src/executorlib/standalone/inputcheck.py. Determine whether wait is intended to be supported; the issue is done when the documented parameter and accepted behavior agree.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 38/100