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

Unclear documentation on how to use dill. #69

Closed
dominik-strutz opened this issue Feb 6, 2023 · 2 comments · Fixed by #70
Closed

Unclear documentation on how to use dill. #69

dominik-strutz opened this issue Feb 6, 2023 · 2 comments · Fixed by #70
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@dominik-strutz
Copy link

Hi everyone,

It is unclear how to use dill if the extras_require install option is not used (or the package is installed using conda). Even if dill is installed, the error message will say that dill is missing despite the problem being that multiprocess is not installed due to the way the following check is implemented:

try: import multiprocess DILL_INSTALLED = True except ImportError: DILL_INSTALLED = False

The resulting error message

("Can't use dill as the dependencies are not installed. Use pip install mpire[dill] to install the required dependencies.")

gives no hint that it is necessary to install multiprocess to use dill. I only found a mention of this on the welcome page of the documentation.

Adding a sentence to the error message should make it easier for people to solve this problem without looking into the source code. If you are busy, I could also look at how to solve this issue best and write up a pull request.

Thanks for this fantastic package!

@sybrenjansen
Copy link
Owner

Hi @dominik-strutz. That's a very good point. I'm already busy with adding some changes to the repo, so might as well add this to the list.

Thnx for pointing it out!

@sybrenjansen sybrenjansen self-assigned this Feb 6, 2023
@sybrenjansen sybrenjansen added the documentation Improvements or additions to documentation label Feb 6, 2023
@sybrenjansen
Copy link
Owner

Released in v2.7.0

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

Successfully merging a pull request may close this issue.

2 participants