Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix a few issues with Plotter.show #3889

Merged
merged 8 commits into from
Jan 30, 2023
Merged

Fix a few issues with Plotter.show #3889

merged 8 commits into from
Jan 30, 2023

Conversation

banesullivan
Copy link
Member

@banesullivan banesullivan commented Jan 28, 2023

Fix a few issues with Plotter.show()

Resolves #1635, Resolves #3548, Resolves #2953, Resolves #1877, Resolves #1665, Resolves #1621

Some cleanups to improve the return values of Plotter.show() so that if return_* is set, the requested item will always be returned.

Further, this removes the store_image property as the whole point of last_image was always to have an image after rendering. I probably need to deprecate this instead of outright removing...

@akaszynski and @pyvista/developers, I would appreciate a thorough review on this one as changing up the show() method nearly always has unexpected consequences

@github-actions github-actions bot added documentation Anything related to the documentation/website bug Uh-oh! Something isn't working as expected. labels Jan 28, 2023
@banesullivan banesullivan added the full-doc Run full documentation build on CI label Jan 28, 2023
@codecov
Copy link

codecov bot commented Jan 28, 2023

Codecov Report

Merging #3889 (a1002b6) into main (23ba481) will increase coverage by 0.02%.
The diff coverage is 94.59%.

@@            Coverage Diff             @@
##             main    #3889      +/-   ##
==========================================
+ Coverage   94.16%   94.19%   +0.02%     
==========================================
  Files          91       91              
  Lines       19586    19566      -20     
==========================================
- Hits        18444    18431      -13     
+ Misses       1142     1135       -7     

@banesullivan
Copy link
Member Author

There is a very odd image regression failure showing up here... hoping that #3891 resolves it

akaszynski
akaszynski previously approved these changes Jan 30, 2023
Copy link
Member

@akaszynski akaszynski left a comment

Choose a reason for hiding this comment

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

A few minor changes, otherwise LGTM.

Since we're maintaining backwards compatibility as much as possible, I agree with the changes here and appreciate removing store_image. It always felt like a hack.

@banesullivan
Copy link
Member Author

Thanks! Merging after CI turns green and will sync #3897

@banesullivan banesullivan merged commit e65873e into main Jan 30, 2023
@banesullivan banesullivan deleted the fix/show-returns branch January 30, 2023 20:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Uh-oh! Something isn't working as expected. documentation Anything related to the documentation/website full-doc Run full documentation build on CI
Projects
None yet
2 participants