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

Replace plt.show() with fig.show() in the docs #37121

Merged
merged 2 commits into from May 7, 2024

Conversation

jhaigh0
Copy link
Contributor

@jhaigh0 jhaigh0 commented Apr 4, 2024

Description of work

Since upgrading to matplotlib 3.7, plt.show() has sometimes created freezing / hanging behaviour when run from within workbench. This pr replaces plt.show() uses in the documentation with fig.show() to make sure all scripts in the docs are compatible with workbench.
We'd still like to find the route cause of this problem, but there is no harm in this change to the docs which will hopefully stop as many people encountering it.

This was suggested in the comments of #36905

To test:

  • cmake with docs plot option on. I could only make the docs build work on linux with this option
    • cmake -DDOCS_PLOTDIRECTIVE=ON --preset=linux
  • build docs-html
  • Check the files which have an uncomented fig.show() within a .. plot::
    • Sometimes the plots weren't showing up on the first build for me (irrespective of the show method), only after I made an edit to the code. Unsure what to suggest in this case ofther than putting a comment or something after the fig.show() to prompt it to re build
  • Check the scripts I've changed a bit more significantly run in mantid

Reviewer

Please comment on the points listed below (full description).
Your comments will be used as part of the gatekeeper process, so please comment clearly on what you have checked during your review. If changes are made to the PR during the review process then your final comment will be the most important for gatekeepers. In this comment you should make it clear why any earlier review is still valid, or confirm that all requested changes have been addressed.

Code Review

  • Is the code of an acceptable quality?
  • Does the code conform to the coding standards?
  • Are the unit tests small and test the class in isolation?
  • If there is GUI work does it follow the GUI standards?
  • If there are changes in the release notes then do they describe the changes appropriately?
  • Do the release notes conform to the release notes guide?

Functional Tests

  • Do changes function as described? Add comments below that describe the tests performed?
  • Do the changes handle unexpected situations, e.g. bad input?
  • Has the relevant (user and developer) documentation been added/updated?

Does everything look good? Mark the review as Approve. A member of @mantidproject/gatekeepers will take care of it.

Gatekeeper

If you need to request changes to a PR then please add a comment and set the review status to "Request changes". This will stop the PR from showing up in the list for other gatekeepers.

@jhaigh0 jhaigh0 added Documentation Issues and pull requests related to documentation ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS labels Apr 4, 2024
@jhaigh0 jhaigh0 added this to the Release 6.10 milestone Apr 4, 2024
Copy link

👋 Hi, @jhaigh0,

Conflicts have been detected against the base branch. Please rebase your branch against the base branch.

@github-actions github-actions bot added the Has Conflicts Used by the bot to label pull requests that have conflicts label Apr 24, 2024
Since upgrading to matplotlib 3.7, plt.show() has sometimes created freezing / hanging behaviour when run from within workbench
@jhaigh0 jhaigh0 force-pushed the 36905_remove_plt_show_from_docs branch from ad323f5 to 5e15a6c Compare April 24, 2024 10:47
@github-actions github-actions bot removed the Has Conflicts Used by the bot to label pull requests that have conflicts label Apr 24, 2024
- Previous noise was so small that Z and ZFit looked identical
- With increased noise it's clear that one is a smooth fit to the noisy data
@SilkeSchomann SilkeSchomann merged commit ab05966 into main May 7, 2024
10 checks passed
@SilkeSchomann SilkeSchomann deleted the 36905_remove_plt_show_from_docs branch May 7, 2024 14:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Issues and pull requests related to documentation ISIS Team: Core Issue and pull requests managed by the Core subteam at ISIS
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants