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

fix broken dev docs #36286

Merged
merged 2 commits into from
Oct 17, 2023
Merged

fix broken dev docs #36286

merged 2 commits into from
Oct 17, 2023

Conversation

rboston628
Copy link
Contributor

Description of work

I broke the dev docs by writing a code block incorrectly.

This should fix it.

Purpose of work

Summary of work

Further detail of work

To test:
Run

ninja dev-docs-html

with branch to make sure the docs build.

Fixes #xxxx.


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.

@rboston628 rboston628 added this to the Release 6.9 milestone Oct 16, 2023
@rboston628 rboston628 marked this pull request as ready for review October 16, 2023 19:01
@sf1919 sf1919 self-assigned this Oct 16, 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.

These changes will make the code block render properly. Happy to approve.

@SilkeSchomann SilkeSchomann merged commit b04ee55 into main Oct 17, 2023
8 checks passed
@SilkeSchomann SilkeSchomann deleted the patch-enumerated-string2 branch October 17, 2023 08:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants