signac-flow icon indicating copy to clipboard operation
signac-flow copied to clipboard

document status_parallelization in API docs

Open atravitz opened this issue 4 years ago • 0 comments

Feature description

status_parallelization was documented as a CLI argument, but since being moved it is not in the API docs anywhere

Proposed solution

Include documentation of the three options (none, thread, process) and warn users that parallelization is only safe if the user's condition functions are parallel safe.

atravitz avatar Mar 24 '21 18:03 atravitz