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 missing inelastic interface screenshots #36846

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Feb 14, 2024

Description of work

This PR fixes an issue where the screenshots for the Inelastic Bayes fitting interface and the Inelastic Settings widget were missing.

I decided to just remove the image for the Settings widget because it is no longer an interface, and an image of it would not be particularly useful.

The Data Analysis image is outdated - it would be better to use an automatic screenshot.

Fixes #36844

To test:

Build the docs locally with DOCS_SCREENSHOTS turned on.
Check that the html files in the build folder for the bayes fitting and data analysis interface have their screenshots.

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.

@robertapplin robertapplin changed the base branch from main to release-next February 14, 2024 10:47
@robertapplin robertapplin added Documentation Issues and pull requests related to documentation Indirect/Inelastic Issues and pull requests related to indirect or inelastic ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS labels Feb 14, 2024
@robertapplin robertapplin added this to the Release 6.9 milestone Feb 14, 2024
@robertapplin robertapplin marked this pull request as ready for review February 14, 2024 10:51
@adriazalvarez adriazalvarez self-assigned this Feb 14, 2024
@sf1919 sf1919 linked an issue Feb 14, 2024 that may be closed by this pull request
@robertapplin robertapplin force-pushed the 0-fix-inelastic-interface-screenshots branch from 3a83932 to 0bd538c Compare February 14, 2024 13:12
Copy link
Contributor

@adriazalvarez adriazalvarez left a comment

Choose a reason for hiding this comment

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

Everything looks good. Thanks for the fix.
I have pointed out some missing corrected lines in one file.

Copy link
Contributor

@adriazalvarez adriazalvarez left a comment

Choose a reason for hiding this comment

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

Perfect! Thank you.

@SilkeSchomann SilkeSchomann merged commit f7c9811 into mantidproject:release-next Feb 15, 2024
9 checks passed
@robertapplin robertapplin deleted the 0-fix-inelastic-interface-screenshots branch May 17, 2024 09:47
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 Indirect/Inelastic Issues and pull requests related to indirect or inelastic ISIS Team: Spectroscopy Issue and pull requests managed by the Spectroscopy subteam at ISIS
Projects
Status: Merged
Development

Successfully merging this pull request may close these issues.

Missing interface screenshots in documentation.
3 participants