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

Don't run doc tests if only dev docs have changed #37349

Merged
merged 1 commit into from
May 16, 2024

Conversation

jhaigh0
Copy link
Contributor

@jhaigh0 jhaigh0 commented May 13, 2024

Description of work

Fixes #37147

To test:


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.

@jhaigh0 jhaigh0 added Documentation Issues and pull requests related to documentation Maintenance Unassigned issues to be addressed in the next maintenance period. labels May 13, 2024
@jhaigh0 jhaigh0 added this to the Release 6.11 milestone May 13, 2024
@jhaigh0 jhaigh0 force-pushed the 37147_no_doc_tests_for_dev_docs branch from 189d3d7 to a8e950c Compare May 13, 2024 13:27
@jhaigh0 jhaigh0 marked this pull request as ready for review May 14, 2024 13:45
@robertapplin robertapplin self-assigned this May 16, 2024
Copy link
Contributor

@robertapplin robertapplin left a comment

Choose a reason for hiding this comment

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

I can confirm that the doc tests are not run if a change has only been made to the dev-docs. The doc tests are run as expected when a change is made to the normal docs

@cailafinn cailafinn merged commit 29f93dd into main May 16, 2024
10 checks passed
@cailafinn cailafinn deleted the 37147_no_doc_tests_for_dev_docs branch May 16, 2024 15:49
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 Maintenance Unassigned issues to be addressed in the next maintenance period.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Changes to dev-docs only should not run doctests
3 participants