[Documentation] Explain shutdown(wait=True) and shutdown(wait=False)
Open
Nobody has claimed this yet.
documentation
- Dominant language
- Python
- Stars
- 77
- Forks
- 7
- Avg merge
- 10h 32m
- Merged PRs (30d)
- 12
Description
This functionality was added in https://github.com/pyiron/executorlib/pull/721 but it is not yet included in the documentation.
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
Review pull request #721 to understand the added shutdown(wait=True) and shutdown(wait=False) behavior, then find the existing documentation for the executor shutdown API. Update the documentation to explain both wait options and verify that the documented behavior matches the implementation introduced there.
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
- Mostly clear
- Newbie friendliness
- 55/100