Allow users to set the waiting time when displaying a preview image using an external viewer #1618
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.
Description of proposed changes
See #1061 for the detailed issue report and discussions.
This PR adds the
waiting
parameter to thelaunch_external_viewer
function. The default value is 0, so no waiting by default.As mentioned in #1061 (comment), the
launch_external_viewer
function is used at two places, one in theFigure.show()
function, another in theFigure.savefig()
function.Figure.show()
opens the preview image in the temporary directory, thus we need to set the waiting time to a non-zero value (waiting=0.5
works for most users) so the external viewer can open the preview image before the PyGMT session exits.Figure.savefig()
opens the image that was already saved in the current directory or elsewhere, and won't be deleted when the PyGMT session exits. Thus there is no need to set the waiting time here.Fixes #1061.
Reminders
make format
andmake check
to make sure the code follows the style guide.doc/api/index.rst
.Slash Commands
You can write slash commands (
/command
) in the first line of a comment to performspecific operations. Supported slash commands are:
/format
: automatically format and lint the code/test-gmt-dev
: run full tests on the latest GMT development version