search

celery / billiard

Multiprocessing Pool Extensions
Other
417 stars 252 forks source link

Readthedocs doesn't mention billiard #301

Open alexmojaki opened 4 years ago

alexmojaki commented 4 years ago

https://billiard.readthedocs.io/en/latest/index.html just looks like a copy of https://docs.python.org/3/library/multiprocessing.html . I get that billiard is a fork of multiprocessing but this doesn't seem right. I literally can't find the string 'billiard' in the documentation.

fedeesku commented 2 years ago

I don't know what's going on. Am I missing something?

alexmojaki commented 2 years ago

This project is a fork of Python's standard library module called multiprocessing. But despite that, it still seems confusing that the official documentation of this project says "Welcome to multiprocessing’s documentation!" instead of "Welcome to billiard's documentation!"

fedeesku commented 2 years ago

Right but for example, looking through the source code - pool.grow() will expand the pool yet this function is no where to be found in the documentation.

If possible, I would like to avoid reading the whole source code to leverage billiards lol.

Let me know what you think @alexmojaki

alexmojaki commented 2 years ago

I think we're in agreement. The docs must be wrong. Most of https://github.com/celery/billiard/tree/master/Doc hasn't been updated in 11 years.

auvipy commented 2 years ago

we have to fix this! i mean I have to! all these were done long before I joined as maintainer 6 years back. 11 years back, I didn't even know how to code in python! anyway thanks for bumping! really sorry that you are facing unusual thing!

fedeesku commented 2 years ago

@auvipy Thank you for responding so quickly! I can appreciate the magnitude of how much work it is to build documentation for a repo of this size. Is this something you guys are targeting for a future release or just need to post current drafts?