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

[documentation] thread.py/process.py docstring mix-up #20

Closed
PavlosMelissinos opened this issue Dec 8, 2018 · 2 comments
Closed

[documentation] thread.py/process.py docstring mix-up #20

PavlosMelissinos opened this issue Dec 8, 2018 · 2 comments

Comments

@PavlosMelissinos
Copy link

Hey there! pypeln has proven really handy for a small/medium data concurrency task I'm dealing with by abstracting python concurrency the right amount, so thanks a bunch for that!

https://github.com/cgarciae/pypeln/blob/master/pypeln/thread.py#L1-L108

This is the same text as the one in process.py. It's slightly confusing, would you consider removing it until it's replaced by the proper description?

@cgarciae
Copy link
Owner

cgarciae commented Dec 9, 2018

Hey @PavlosMelissinos !

Yeah, sorry about the confusion. Because the process and thread modules where so similar, I just implemented the process module and copied the code over to the thread module, the only difference is in some definition as the beginning which I just commented out. This means that documentation for the thread module is exactly the same as in the process module (which is wrong).

I am slowly but surely working on this so I'll keep you posted. If you have any doubts don't hesitate to ask.

@PavlosMelissinos
Copy link
Author

PavlosMelissinos commented Dec 10, 2018

Yeah, it's mostly the first line, as well as stuff like from pypeln import process as pr -> from pypeln import thread as th and references of python's multiprocessing module.

It's not a big deal, just a little bit confusing ;)

Thanks!

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

No branches or pull requests

2 participants