From 3ed6f1cc74e41cd489d0a4c4c5803c1e80cca4c3 Mon Sep 17 00:00:00 2001 From: Jonathan Matthews Date: Thu, 9 Jan 2025 11:46:19 +0000 Subject: [PATCH] docs: minor updates This tweaks some docs following PR feedback. --- docs/DEVELOPMENT.md | 7 +++++-- docs/INSTALL.md | 2 +- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/DEVELOPMENT.md b/docs/DEVELOPMENT.md index 06f8e61bd..ad47532d3 100644 --- a/docs/DEVELOPMENT.md +++ b/docs/DEVELOPMENT.md @@ -85,8 +85,11 @@ Alternatively, you can populate the database using the public YNR API. 1. Start the compose stack: `podman compose up -d` -1. Run the test suite, stopping on first failure: - `./scripts/container.pytest.bash -x` +1. Run the test suite: + `./scripts/container.pytest.bash` + - We can provide additional pytest options. + For example, to run the test suite and stop on the first failure: + `./scripts/container.pytest.bash -x` 1. Stop the compose stack: `podman compose down` diff --git a/docs/INSTALL.md b/docs/INSTALL.md index a8cd24f0b..a944f1063 100644 --- a/docs/INSTALL.md +++ b/docs/INSTALL.md @@ -59,6 +59,6 @@ and to get closer to the intended future state of the application's This will take a little time to finish: `./scripts/container.pytest.bash` 1. Shut down the compose stack: - `podman compose stop` + `podman compose down` Now you can use the tools and workflows detailed in [DEVELOPMENT.md](DEVELOPMENT.md).