Skip to content

Conversation

peterfpeterson
Copy link
Member

Since the description of the various fields is something that is frequently repeated, add a link in the algorithm documentation. This adds a link to the text and changes the description paragraph to use semantic line breaks.

There is no associated issue.

To test:

Build the docs and test the new link in the LoadEventNexus algorithm page.

This does not require release notes because it adds a single link to the algorithm 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.

Since the description of the various fields is something that is
frequently repeated, add a link in the algorithm documentation.
@peterfpeterson peterfpeterson added the Documentation Issues and pull requests related to documentation label Aug 19, 2024
@peterfpeterson peterfpeterson added this to the Release 6.11 milestone Aug 19, 2024
@sf1919 sf1919 self-assigned this Aug 20, 2024
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 have successfully built the documentation locally. It looks correctly formatted and all the links work. Spelling correct so happy to approve.

@SilkeSchomann SilkeSchomann self-assigned this Aug 20, 2024
@SilkeSchomann SilkeSchomann merged commit a51c7a3 into mantidproject:main Aug 20, 2024
1 check passed
@peterfpeterson peterfpeterson deleted the link_to_nxs branch August 20, 2024 17:33
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
None yet
Development

Successfully merging this pull request may close these issues.

3 participants