Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

document status_parallelization in API docs #485

Open
atravitz opened this issue Mar 24, 2021 · 0 comments
Open

document status_parallelization in API docs #485

atravitz opened this issue Mar 24, 2021 · 0 comments
Labels
documentation Writing or editing documentation good first issue Good for newcomers

Comments

@atravitz
Copy link
Collaborator

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.
@csadorf csadorf added the documentation Writing or editing documentation label Mar 25, 2021
@kidrahahjo kidrahahjo added the good first issue Good for newcomers label Mar 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Writing or editing documentation good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@csadorf @atravitz @kidrahahjo