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

Release notes for 6.11 #38129

Merged
merged 28 commits into from
Oct 16, 2024
Merged

Release notes for 6.11 #38129

merged 28 commits into from
Oct 16, 2024

Conversation

GuiMacielPereira
Copy link
Contributor

Description of work

This PR contains the bulk of the edited release notes

Summary of work

Went over release notes and edited them so they fit the same format.

Further detail of work

To test:

Read over release notes to correct any typos.
Build and open release notes to check for formatting issues.


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.

Ran release_editor.py script and commited the resulting changes
@GuiMacielPereira GuiMacielPereira added the Documentation Issues and pull requests related to documentation label Oct 2, 2024
@GuiMacielPereira GuiMacielPereira added this to the Release 6.11 milestone Oct 2, 2024
@thomashampson thomashampson self-assigned this Oct 3, 2024
@GuiMacielPereira GuiMacielPereira marked this pull request as ready for review October 7, 2024 16:32
@GuiMacielPereira
Copy link
Contributor Author

There is a TODO on index.rst as a reminder to add a paragraph about the mantid developer package. @thomashampson I think you would be the best person to write that?

@jhaigh0
Copy link
Contributor

jhaigh0 commented Oct 9, 2024

This should be pointing into release-next

@jhaigh0
Copy link
Contributor

jhaigh0 commented Oct 9, 2024

Also release-next-6-11 is quite a confusing name for this branch :')

Copy link
Contributor

@jhaigh0 jhaigh0 left a comment

Choose a reason for hiding this comment

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

lots of minor things in this review. Make sure to go to the files tab and select 'Add suggestion to batch' for the one you want to accept, rather than making a commit for each.

docs/source/release/v6.11.0/diffraction.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/diffraction.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/diffraction.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/diffraction.rst Show resolved Hide resolved
docs/source/release/v6.11.0/diffraction.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/muon.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/reflectometry.rst Outdated Show resolved Hide resolved
thomashampson and others added 2 commits October 11, 2024 14:09
Co-authored-by: Jonathan Haigh <35813666+jhaigh0@users.noreply.github.com>
Co-authored-by: RichardWaiteSTFC <55979119+RichardWaiteSTFC@users.noreply.github.com>
Co-authored-by: Jonathan Haigh <35813666+jhaigh0@users.noreply.github.com>
Copy link
Contributor

@thomashampson thomashampson left a comment

Choose a reason for hiding this comment

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

some more small changes and a question for @jclarkeSTFC

The effect is that there is no longer negative bin edges unless there is actually a negative time-of-flight in the data.
- Isotope densities have been updated, see https://pypi.org/project/periodictable/1.6.1/#history for notes about the updates from NIST.
- Algorithm `IntegratePeaks1DProfile <algm-IntegratePeaks1DProfile-v1>` no longer references `numpy.distutils`, since as of NumPy 1.23.0 it is deprecated.
- All sample times are now allowed to be before 01/01/1991.
Copy link
Contributor

Choose a reason for hiding this comment

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

@jclarkeSTFC I think the rewording of this has broken the meaning of the fix. Can you suggest something that describes the fix?

docs/source/release/v6.11.0/framework.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/index.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/inelastic.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/inelastic.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
docs/source/release/v6.11.0/mantidworkbench.rst Outdated Show resolved Hide resolved
@thomashampson
Copy link
Contributor

I'm happy for this to be merged pending one change to this line, which is a bit confusing:
- All sample times are now allowed to be before 01/01/1991.

Co-authored-by: James Clarke <139879523+jclarkeSTFC@users.noreply.github.com>
Copy link
Contributor

@thomashampson thomashampson left a comment

Choose a reason for hiding this comment

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

All requested changes have been implemented and docs build is fine.

@thomashampson thomashampson merged commit 4a0cabd into release-next Oct 16, 2024
10 checks passed
@thomashampson thomashampson deleted the release-next-6-11 branch October 16, 2024 13:56
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
Status: Done
Development

Successfully merging this pull request may close these issues.

5 participants