[Documentation] Explain shutdown(wait=True) and shutdown(wait=False)

Open
#723 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
55/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

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.

Description

documentation

This functionality was added in https://github.com/pyiron/executorlib/pull/721 but it is not yet included in the documentation.

Dominant language
Python
Stars
77
Forks
7
Avg merge
10h 32m
Merged PRs (30d)
12

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from pyiron/executorlib

All issues in pyiron/executorlib

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.