DOC Improve doc about joblib warnings #1367
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lucyleeow
commented
Aug 3, 2024
doc/configuration.rst
Outdated
| Python warnings emitted by :mod:`joblib` during gallery generation (e.g., the | ||
| ``UserWarning`` about a | ||
| `worker restarting <https://github.com/joblib/joblib/issues/883>`_), | ||
| will be captured by Sphinx-Gallery. These can be filtered out with |
There was a problem hiding this comment.
Also not sure if these warnings are included in code execution output, so I've left at a vague 'capture'...?
There was a problem hiding this comment.
Actually thinking again, it may be to do with when the warning is emitted, at the time of gallery generation/example execution which is why it causes examples to fail (when warnings are error)
There was a problem hiding this comment.
I've amended the doc, hopefully it is right and makes sense
larsoner
reviewed
Aug 3, 2024
larsoner
approved these changes
Aug 3, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Follow on from #1362