From f2eb9ef784b5641bf1582c333e7d18c3aa418a5e Mon Sep 17 00:00:00 2001 From: mgaughan Date: Mon, 21 Jul 2025 17:55:48 -0400 Subject: [PATCH 1/4] correcting to double-dash in the poetry install documentation --- docs/source/development/developer_guidelines.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/development/developer_guidelines.md b/docs/source/development/developer_guidelines.md index dd94c57..e32b53a 100644 --- a/docs/source/development/developer_guidelines.md +++ b/docs/source/development/developer_guidelines.md @@ -21,7 +21,7 @@ This allows you to run the auto-archiver without the `poetry run` prefix. ### Optional Development Packages Install development packages (used for unit tests etc.) using: -`poetry install -with dev` +`poetry install --with dev` ```{toctree} @@ -33,4 +33,4 @@ docs release settings_page style_guide -``` \ No newline at end of file +``` From 65e222e177a2e4d9af5578fa2c670bed4e136e3f Mon Sep 17 00:00:00 2001 From: mgaughan Date: Tue, 22 Jul 2025 17:20:59 -0400 Subject: [PATCH 2/4] fixing typo in documentation pytest -> poetry --- docs/source/development/testing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/development/testing.md b/docs/source/development/testing.md index 290592c..c17ab51 100644 --- a/docs/source/development/testing.md +++ b/docs/source/development/testing.md @@ -8,7 +8,7 @@ ## Running Tests -1. Make sure you've installed the dev dependencies with `pytest install --with dev` +1. Make sure you've installed the dev dependencies with `poetry install --with dev` 2. Tests can be run as follows: ```{code} bash #### Command prefix of 'poetry run' removed here for simplicity @@ -29,4 +29,4 @@ pytest -ra -v tests/test_file.py::test_function_name 3. Some tests require environment variables to be set. You can use the example `.env.test.example` file as a template. Copy it to `.env.test` and fill in the required values. This file will be loaded automatically by `pytest`. ```{code} bash cp .env.test.example .env.test -``` \ No newline at end of file +``` From 1256fde1591ea279063af3afb4ba3f9fd9626c22 Mon Sep 17 00:00:00 2001 From: mgaughan Date: Wed, 23 Jul 2025 13:04:48 -0400 Subject: [PATCH 3/4] updating location of .env.test.example in documentation --- docs/source/development/testing.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/development/testing.md b/docs/source/development/testing.md index c17ab51..f72dd94 100644 --- a/docs/source/development/testing.md +++ b/docs/source/development/testing.md @@ -26,7 +26,7 @@ pytest -ra -v tests/test_file.py pytest -ra -v tests/test_file.py::test_function_name ``` -3. Some tests require environment variables to be set. You can use the example `.env.test.example` file as a template. Copy it to `.env.test` and fill in the required values. This file will be loaded automatically by `pytest`. +3. Some tests require environment variables to be set. You can use the example `tests/.env.test.example` file as a template. Copy it to `tests/.env.test` and fill in the required values. This file will be loaded automatically by `pytest`. ```{code} bash -cp .env.test.example .env.test +cp tests/.env.test.example tests/.env.test ``` From 80beab9f23d888d668405b42de50f105abe349e2 Mon Sep 17 00:00:00 2001 From: mgaughan Date: Tue, 5 Aug 2025 21:36:32 -0400 Subject: [PATCH 4/4] ruff-fix -> ruff-clean; there is no ruff-fix in the Makefile. Maybe the command /should/ be ruff-fix to align with the underlying ruff command; for later discussion. This at least reconciles the documentation to the Makefile --- docs/source/development/style_guide.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/development/style_guide.md b/docs/source/development/style_guide.md index 390f11a..f1e61ac 100644 --- a/docs/source/development/style_guide.md +++ b/docs/source/development/style_guide.md @@ -50,7 +50,7 @@ Note not all warnings can be fixed automatically. Most fixes are safe, but some non-standard practices such as dynamic loading are not picked up by linters. Ensure you check any modifications by this before committing them. ```shell -make ruff-fix +make ruff-clean ``` **Changing Configurations ⚙️** @@ -67,4 +67,4 @@ One example is to extend the selected rules for linting the `pyproject.toml` fil extend-select = ["B"] ``` -Then re-run the `make ruff-check` command to see the new rules in action. \ No newline at end of file +Then re-run the `make ruff-check` command to see the new rules in action.