From 084159cee507b3d58f5ea0a5b7108c744db983af Mon Sep 17 00:00:00 2001 From: Henry Schreiner Date: Fri, 24 Jul 2026 18:25:43 -0400 Subject: [PATCH] fix: broken links reported by the learn site link check The MyST link in the docs guide had no scheme, so it built as the site-relative path `/developmentmystmd.org`. The explicit `(unit-tests)=` target in the testing principles collided with the implicit heading target from `## Unit tests` in the GitHub Actions guide, so both `{ref}` uses pointed at the wrong page. Rename it to `unit-tests-principles`. Assisted-by: ClaudeCode:claude-opus-5 --- docs/guides/docs.md | 4 ++-- docs/principles/testing.md | 19 ++++++++++--------- 2 files changed, 12 insertions(+), 11 deletions(-) diff --git a/docs/guides/docs.md b/docs/guides/docs.md index 303712ad..0ac9746e 100644 --- a/docs/guides/docs.md +++ b/docs/guides/docs.md @@ -33,8 +33,8 @@ template. There are lots of options, though: creators of `mkdocs-material` and `mkdocstrings`, designed as a faster, simpler successor to MkDocs. Configured with TOML and largely compatible with `mkdocs-material` sites, but still in early development. -- [MyST](mystmd.org): A powerful system for rendering markdown and notebooks. - Can also be used for docs, though, see +- [MyST](https://mystmd.org): A powerful system for rendering markdown and + notebooks. Can also be used for docs, though, see [echopype](https://echopype.readthedocs.io). AKA JupyterBook. - [Great Docs](https://posit-dev.github.io/great-docs/): A system with minimal configuration and modern features for making docs, based on Quarto. diff --git a/docs/principles/testing.md b/docs/principles/testing.md index f44dcd5f..96ecb5f4 100644 --- a/docs/principles/testing.md +++ b/docs/principles/testing.md @@ -12,9 +12,9 @@ the Features that your project provides. Then we will cover [Project Level Integration tests](#project-level-integration-tests), which test that the various parts of your package work together, and work with the other packages it depends on. Finally we will cover the venerable -{ref}`Unit Test `, which test the correctness of your code from a -perspective internal to your codebase, tests individual units in isolation, and -are optimized to run quickly and often. +{ref}`Unit Test `, which test the correctness of your +code from a perspective internal to your codebase, tests individual units in +isolation, and are optimized to run quickly and often. These 3 test suites will cover the bulk of your testing needs and help get your project to a reliable and maintainable state. We will also discuss some more @@ -97,11 +97,12 @@ Tests should be divided up into different Suites, which can be run independently of one another. Tests which "Fail Fast" save both developer and compute time. Some tests are by -necessity very slow. {ref}`Unit Tests ` should run extremely quickly -in just a few seconds at most, while [end-to-end](#end-to-end-tests) require -time to set up and may depend on slow and unreliable external services. By -organizing tests into suites based on execution time, you can run fast suites -first and stop if an error is encountered before running slower suites. +necessity very slow. {ref}`Unit Tests ` should run +extremely quickly in just a few seconds at most, while +[end-to-end](#end-to-end-tests) require time to set up and may depend on slow +and unreliable external services. By organizing tests into suites based on +execution time, you can run fast suites first and stop if an error is +encountered before running slower suites. ### Advantages of Test Suites @@ -196,7 +197,7 @@ more extensive validation. The intended audience for these tests is developers working on the project. -(unit-tests)= +(unit-tests-principles)= ## Unit Tests