Skip to content

Commit

Permalink
docs: minor updates
Browse files Browse the repository at this point in the history
This tweaks some docs following PR feedback.
  • Loading branch information
jpluscplusm committed Jan 9, 2025
1 parent 4c0c1a5 commit 3ed6f1c
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 3 deletions.
7 changes: 5 additions & 2 deletions docs/DEVELOPMENT.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
2 changes: 1 addition & 1 deletion docs/INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

0 comments on commit 3ed6f1c

Please sign in to comment.