Skip to content

Conversation

thomashampson
Copy link
Contributor

@thomashampson thomashampson commented Oct 11, 2024

Description of work

Sphinx 8.0.2 -> 8.1.0 upgrade found an unused reference, which causes a warning. Then the nighlty builds failed. Here we make use of the reference to fix the warning.

There is no associated issue.

To test:

Ensure the docs build and linux package build pass and that the reference is in a sensible place.

This does not require release notes because it is a minor update to docs


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.

Co-authored-by: jclarkeSTFC <james.clarke@stfc.ac.uk>
@thomashampson thomashampson added Documentation Issues and pull requests related to documentation Dependencies Pull requests that update a dependency file ISIS: Core Issue and pull requests at ISIS that relate to Core features and functions Muon Issues and pull requests related to muons High Priority An issue or pull request that if not addressed is severe enough to postponse a release. and removed ISIS: Core Issue and pull requests at ISIS that relate to Core features and functions labels Oct 11, 2024
@thomashampson thomashampson added this to the Release 6.11 milestone Oct 11, 2024
@thomashampson thomashampson marked this pull request as ready for review October 11, 2024 08:45
@robertapplin
Copy link
Contributor

Does the target need to change to release-next?

@SilkeSchomann SilkeSchomann self-assigned this Oct 11, 2024
@thomashampson thomashampson changed the base branch from main to release-next October 11, 2024 08:56
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.

All tests pass and the reference is in a sensible place 👍🏻

@robertapplin robertapplin self-assigned this Oct 11, 2024
@robertapplin robertapplin merged commit f0a5e8a into release-next Oct 11, 2024
10 checks passed
@robertapplin robertapplin deleted the fix_muon_sphinx_warning branch October 11, 2024 09:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependencies Pull requests that update a dependency file Documentation Issues and pull requests related to documentation High Priority An issue or pull request that if not addressed is severe enough to postponse a release. Muon Issues and pull requests related to muons
Projects
No open projects
Status: Done
Development

Successfully merging this pull request may close these issues.

3 participants