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

Clean up Inelastic release notes #36833

Conversation

robertapplin
Copy link
Contributor

@robertapplin robertapplin commented Feb 9, 2024

Description of work

This PR does some cleanup for the Inelastic release notes so they are ready for the release of Mantid v6.9.

To test:

Read through the Inelasitc release notes to make sure they make sense/no typos. Build the docs to check the image is displaying correctly.

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 added the Documentation Issues and pull requests related to documentation label Feb 9, 2024
@robertapplin robertapplin added this to the Release 6.9 milestone Feb 9, 2024
@robertapplin robertapplin marked this pull request as ready for review February 9, 2024 11:04
Copy link
Contributor

@backmari backmari left a comment

Choose a reason for hiding this comment

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

Looks good! Just added one question. Thanks for adding a picture.

@@ -8,36 +8,41 @@ Inelastic Changes
New Features
------------
- The :ref:`Interface Settings <interface-indirect-settings>` has a new advanced option called ``Developer Feature Flags``. When developing a large new feature, developers will create a flag that can be used by advanced software users for purposes of rapid prototyping and allowing a faster feedback loop.
Copy link
Contributor

Choose a reason for hiding this comment

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

I see that the link points to something under "Indirect". Do Indirect and Inelastic share this feature? Sorry, don't know this area at all!

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good spot, yes you are right that both Indirect and Inelastic interface categories share a common settings widget. This link for the settings page is however a bit outdated because it suggests that the settings widget is only used by indirect. I have updated the link to a better name inelastic-interface-settings. This is a better description because inelastic encompasses indirect, whereas indirect does not encompass all of inelastic (we can also have direct inelastic)!

backmari
backmari previously approved these changes Feb 12, 2024
Copy link
Contributor

@SilkeSchomann SilkeSchomann left a comment

Choose a reason for hiding this comment

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

LGTM 👍

@SilkeSchomann SilkeSchomann merged commit 7304d1a into mantidproject:release-next Feb 14, 2024
9 checks passed
@robertapplin robertapplin deleted the 0-cleanup-inelastic-release-notes 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
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants