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 formatting in DeprecateAlgorithm dev-docs #39021

Merged

Conversation

peterfpeterson
Copy link
Member

@peterfpeterson peterfpeterson commented Mar 6, 2025

Fix formatting so code-blocks render correctly. There was too much whitespace on the left hand side of them.

There is no associated issue.

To test:

ninja dev-docs-html

and look at the HTML page. It should be much better now.

This does not require release notes because it is a formatting fix in the developer documentation.


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.

@peterfpeterson peterfpeterson added the Documentation Issues and pull requests related to documentation label Mar 6, 2025
@peterfpeterson peterfpeterson added this to the Release 6.13 milestone Mar 6, 2025
@peterfpeterson peterfpeterson marked this pull request as ready for review March 6, 2025 15:08
@sf1919 sf1919 self-assigned this Mar 7, 2025
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 built the page locally and it does he formatting changes expected with no failures or warnings.

@jclarkeSTFC jclarkeSTFC self-assigned this Mar 7, 2025
Copy link
Contributor

@jclarkeSTFC jclarkeSTFC left a comment

Choose a reason for hiding this comment

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

Docs are formatted correctly.

@jclarkeSTFC jclarkeSTFC merged commit 32857d9 into mantidproject:main Mar 7, 2025
10 checks passed
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