Skip to content

Suggest make test and rearrange for clarity in testing docs#1915

Merged
daflack merged 2 commits intomainfrom
document_make_test
Feb 18, 2026
Merged

Suggest make test and rearrange for clarity in testing docs#1915
daflack merged 2 commits intomainfrom
document_make_test

Conversation

@jfrost-mo
Copy link
Member

@jfrost-mo jfrost-mo commented Feb 18, 2026

As suggested in #1914 (review).

When I wrote this page originally it was primarily a dumping ground for testing philosophy and ideas. This background information is useful, but is secondary to how to actually run tests, and has therefore been moved under a heading. This makes the test running instructions much clearer.

In future this page could be expanded with a guide on writing tests, as currently we only have a little bit on how to document them.

Contribution checklist

Aim to have all relevant checks ticked off before merging. See the developer's guide for more detail.

  • Documentation has been updated to reflect change.
  • New code has tests, and affected old tests have been updated.
  • All tests and CI checks pass.
  • Ensured the pull request title is descriptive.
  • Conda lock files have been updated if dependencies have changed.
  • Attributed any Generative AI, such as GitHub Copilot, used in this PR.
  • Marked the PR as ready to review.

When I wrote this page originally it was primarily a dumping ground for
testing philosophy and ideas. This background information is useful, but
is secondary to how to actually run tests, and has therefore been moved
under a heading. This makes the test running instructions much clearer.

In future this page could be expanded with a guide on writing tests, as
currently we only have a little bit on how to document them.
@jfrost-mo jfrost-mo self-assigned this Feb 18, 2026
@jfrost-mo jfrost-mo added the documentation Improvements or additions to documentation label Feb 18, 2026
@jfrost-mo jfrost-mo marked this pull request as ready for review February 18, 2026 13:31
@jfrost-mo jfrost-mo requested a review from daflack February 18, 2026 13:32
@github-actions
Copy link
Contributor

Coverage

Copy link
Collaborator

@daflack daflack left a comment

Choose a reason for hiding this comment

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

Thanks for doing this, it looks good to me.

@daflack daflack merged commit e1e84b5 into main Feb 18, 2026
8 checks passed
@daflack daflack deleted the document_make_test branch February 18, 2026 13:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments