Set appropriate stacklevel for userwarnings #2405
Open
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.
I typically try to set the stacklevel to point to the correct location where the user can fix the warning in their code.
Previously, the stack level would point the user to some deep deep internal method for vispy.
The
_stacklevel_increment
is designed to be an internal (vispy-only) parameter that allows passing the warning upward to the user's originating call.