Skip to content

DOC: Document call better#1348

Merged
tomMoral merged 3 commits into
joblib:masterfrom
larsoner:docs
Sep 30, 2022
Merged

DOC: Document call better#1348
tomMoral merged 3 commits into
joblib:masterfrom
larsoner:docs

Conversation

@larsoner

Copy link
Copy Markdown
Contributor

I was happy to see this method existed, but I was confused by the output not being what I expected. This adds a minimal docstring to help the next person.

@codecov

codecov Bot commented Sep 29, 2022

Copy link
Copy Markdown

Codecov Report

Base: 94.04% // Head: 94.02% // Decreases project coverage by -0.02% ⚠️

Coverage data is based on head (f9d4373) compared to base (3fb7fbd).
Patch has no changes to coverable lines.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1348      +/-   ##
==========================================
- Coverage   94.04%   94.02%   -0.03%     
==========================================
  Files          52       52              
  Lines        7292     7292              
==========================================
- Hits         6858     6856       -2     
- Misses        434      436       +2     
Impacted Files Coverage Δ
joblib/memory.py 95.25% <ø> (ø)
joblib/parallel.py 96.29% <0.00%> (-0.53%) ⬇️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@larsoner

Copy link
Copy Markdown
Contributor Author

@tomMoral tomMoral left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice addition!
I agree that it is confusing other wise.

just a small comment

Comment thread joblib/memory.py Outdated

@tomMoral tomMoral left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@tomMoral
tomMoral merged commit cc0b2a8 into joblib:master Sep 30, 2022
@larsoner
larsoner deleted the docs branch April 26, 2023 20:01
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

Successfully merging this pull request may close these issues.

2 participants