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.

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

Missing comprehensive docs on worker pool types #8203

Open
4 tasks done
micahjsmith opened this issue Apr 14, 2023 · 1 comment
Open
4 tasks done

Missing comprehensive docs on worker pool types #8203

micahjsmith opened this issue Apr 14, 2023 · 1 comment

Comments

@micahjsmith
Copy link

Checklist

  • I have checked the issues list
    for similar or identical bug reports.
  • I have checked the pull requests list
    for existing proposed fixes.
  • I have checked the commit log
    to find out if the bug was already fixed in the main branch.
  • I have included all related issues and possible duplicate issues in this issue
    (If there are none, check this box anyway).

Description

The docs are missing a comprehensive discussion of the worker pool types.

The docs I have found:

There are also various changelog entries (hard to find, usually announce the very initial version of the pool type but not subsequent changes/improvements) and docstrings exposed from celery.concurrency like https://docs.celeryq.dev/en/latest/internals/reference/celery.concurrency.thread.html (not very descriptive)

Suggestions

I suggest that a new section be written in userguide/workers titled Pools which has a more comprehensive user-facing discussion of pool types including:

  • how the pool type works and any limitations it has
  • considerations for choosing among pool types

An excellent (but outdated) example of this type of documentation is https://distributedpython.com/posts/celery-execution-pools-what-is-it-all-about/

I'm happy to make a PR with a draft of this but would like to collaborate with someone who has more extensive understanding the different pool types to make sure it is more comprehensive

@open-collective-bot
Copy link

Hey @micahjsmith 👋,
Thank you for opening an issue. We will get back to you as soon as we can.
Also, check out our Open Collective and consider backing us - every little helps!

We also offer priority support for our sponsors.
If you require immediate assistance please consider sponsoring us.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant