Skip to content
New issue

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

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

Already on GitHub? # to your account

Add more information to release notes about event filtering #35464

Merged

Conversation

peterfpeterson
Copy link
Member

Adds clarifying comments about arithmetic statistics and how values are deleted from logs.

To test:

Review the release notes

Refs #34794.


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?
  • Are the release notes saved in a separate file, using Issue or PR number for file name and in the correct location?
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.

@peterfpeterson peterfpeterson added this to the Release 6.7 milestone Apr 18, 2023
@sf1919 sf1919 self-assigned this Apr 19, 2023
Copy link
Contributor

@sf1919 sf1919 left a comment

Choose a reason for hiding this comment

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

I've looked over the text and that looks ok - although generally the release notes have unnumbered bullet point lists unless there is a very specific reason to number them.

I did build the page and the links work. However there was a warning given that probably needs to be resolved.
release/v6.7.0/framework:2: WARNING: Bullet list ends without a blank line; unexpected unindent.

@peterfpeterson
Copy link
Member Author

I changed the enumeration to a bulleted list and fixed a minor issue with a different doc. The warning you point out comes from how the "amalgamate" command works

Copy link
Contributor

@sf1919 sf1919 left a comment

Choose a reason for hiding this comment

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

Thanks for changing to a bullet point list. The documentation warnings need to be dealt with but they go beyond just this release note and so I've raised it separately (#35473).

@jmborr jmborr merged commit 42b3c2a into mantidproject:main Apr 24, 2023
@peterfpeterson peterfpeterson deleted the event_filtering_release_notes branch April 24, 2023 14:48
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants