From 9cb3c714048f8344a8ba53fe8c226ee9c8e6c02e Mon Sep 17 00:00:00 2001 From: dangotbanned <125183946+dangotbanned@users.noreply.github.com> Date: Sat, 13 Jul 2024 12:51:04 +0100 Subject: [PATCH 1/3] docs: fix phrasing in in *Testing your Changes* --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4471f6e84..637c923d2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,7 +67,7 @@ please read [the maintainers' notes](NOTES_FOR_MAINTAINERS.md). ### Testing your Changes -Before suggesting your contributing your changing to the main Altair repository, +Before submitting your changes to the main Altair repository, it is recommended that you run the Altair test suite, which includes a number of tests to validate the correctness of your code: From 70264d2cde51a5b9b913b7546d9a60b2afbe1df2 Mon Sep 17 00:00:00 2001 From: dangotbanned <125183946+dangotbanned@users.noreply.github.com> Date: Sat, 13 Jul 2024 12:58:03 +0100 Subject: [PATCH 2/3] docs: Use more consistent comments in *Failures on specific python version(s)* These commands are referring to `hatch` environments named like `hatch-test.py3.8`, but not `doc` or `default`. It is simpler to just describe this as python versions. Also the [hatch test](https://hatch.pypa.io/latest/cli/reference/#hatch-test) docs refer to `--python` as accepting multiple versions, but do not give an example with more than one. I've not figured out how this would work, so this keeps it simple. --- CONTRIBUTING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 637c923d2..aac5376de 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -86,9 +86,9 @@ before proceeding to the next section. By default, `hatch test` will run the test suite against the currently active python version. Two useful variants for debugging failures that only appear *after* you've submitted your PR: ```bash -# Test all environments in the matrix +# Test against all python version(s) in the matrix hatch test --all -# The Python versions to test +# Test against a specific python version hatch test --python 3.8 ``` From d8d15fd7b4102f37b468b54947445077f5fb456c Mon Sep 17 00:00:00 2001 From: dangotbanned <125183946+dangotbanned@users.noreply.github.com> Date: Sat, 13 Jul 2024 12:58:52 +0100 Subject: [PATCH 3/3] docs: wrap long line --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aac5376de..541339a6b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -83,7 +83,8 @@ Study the output of any failed tests and try to fix the issues before proceeding to the next section. #### Failures on specific python version(s) -By default, `hatch test` will run the test suite against the currently active python version. Two useful variants for debugging failures that only appear *after* you've submitted your PR: +By default, `hatch test` will run the test suite against the currently active python version. +Two useful variants for debugging failures that only appear *after* you've submitted your PR: ```bash # Test against all python version(s) in the matrix