BUG: Fix errors in example usage of ignore_repr_types and reset_argv#1275
Merged
larsoner merged 3 commits intosphinx-gallery:masterfrom Mar 20, 2024
Merged
BUG: Fix errors in example usage of ignore_repr_types and reset_argv#1275larsoner merged 3 commits intosphinx-gallery:masterfrom
larsoner merged 3 commits intosphinx-gallery:masterfrom
Conversation
Reverts formatting changes from 50fdf82.
The example of how to use `reset_argv` is wrong, or at least misleading on two counts. One, it must return an iterable in all cases, so there should be a default case returning `[]`. Two, the value of `script_vars['src_file']` is an absolute path, not just a filename, so just `sample1.py` won't ever be matched.
Contributor
|
Thanks @speth ! |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
reset_argvis wrong, or at least misleading on two counts. One, it must return an iterable in all cases, so there should be a default case returning[]. Two, the value ofscript_vars['src_file']is an absolute path, not just a filename, so justsample1.pywon't ever be matched.ignore_repr_typesso it actually does what's described in the text.