DEV: add Pixi task descriptions

Author: j-bowhay

pixi.lock

@@ -70,12 +70,12 @@ dask-core = ">=2025.3.0"     # No distributed, tornado, etc.
 # as they slow down mypy and are not portable across target OSs
 
 [tool.pixi.feature.lint.tasks]
-pre-commit-install = "pre-commit install"
-pre-commit = "pre-commit run --all-files"
-mypy = "mypy"
-pylint = { cmd = "pylint array_api_extra", cwd = "src" }
-pyright = "basedpyright"
-lint = { depends-on = ["pre-commit", "pylint", "mypy", "pyright"] }
+pre-commit-install = { cmd = "pre-commit install", description = "Install pre-commit"}
+pre-commit = { cmd = "pre-commit run --all-files", description = "Run pre-commit"}
+mypy = { cmd = "mypy", description="Type check with mypy"}
+pylint = { cmd = "pylint array_api_extra", cwd = "src" , description = "Lint using pylint"}
+pyright = { cmd = "basedpyright", description = "Type check with basedpyright"}
+lint = { depends-on = ["pre-commit", "pylint", "mypy", "pyright"] , description = "Run pre-commit, pylint, mypy, and pyright"}
 
 [tool.pixi.feature.tests.dependencies]
 pytest = ">=8.3.5"
@@ -85,18 +85,18 @@ array-api-strict = ">=2.3.1"
 numpy = ">=1.22.0"
 
 [tool.pixi.feature.tests.tasks]
-tests = "pytest -v"
-tests-cov = "pytest -v -ra --cov --cov-report=xml --cov-report=term --durations=20"
+tests = { cmd = "pytest -v", description = "Run tests"}
+tests-cov = { cmd="pytest -v -ra --cov --cov-report=xml --cov-report=term --durations=20", description = "Run tests with coverage"}
 
-clean-vendor-compat = "rm -rf vendor_tests/array_api_compat"
-clean-vendor-extra = "rm -rf vendor_tests/array_api_extra"
-copy-vendor-compat = { cmd = "cp -r $(python -c 'import site; print(site.getsitepackages()[0])')/array_api_compat vendor_tests/", depends-on = ["clean-vendor-compat"] }
-copy-vendor-extra = { cmd = "cp -r src/array_api_extra vendor_tests/", depends-on = ["clean-vendor-extra"] }
-tests-vendor = { cmd = "pytest -v vendor_tests", depends-on = ["copy-vendor-compat", "copy-vendor-extra"] }
+clean-vendor-compat = { cmd = "rm -rf vendor_tests/array_api_compat", description = "Delete the existing vendored version of array-api-compat"}
+clean-vendor-extra = { cmd = "rm -rf vendor_tests/array_api_extra" , description = "Delete the existing vendored version of array-api-extra"}
+copy-vendor-compat = { cmd = "cp -r $(python -c 'import site; print(site.getsitepackages()[0])')/array_api_compat vendor_tests/", depends-on = ["clean-vendor-compat"] , description = "Vendor a clean copy of array-api-compat"}
+copy-vendor-extra = { cmd = "cp -r src/array_api_extra vendor_tests/", depends-on = ["clean-vendor-extra"] , description = "Vendor a clean copy of array-api-extra"}
+tests-vendor = { cmd = "pytest -v vendor_tests", depends-on = ["copy-vendor-compat", "copy-vendor-extra"] , description = "Check that array-api-extra and array-api-compat can be vendored together" }
 
-tests-ci = { depends-on = ["tests-cov", "tests-vendor"] }
-coverage = { cmd = "coverage html", depends-on = ["tests-cov"] }
-open-coverage = { cmd = "open htmlcov/index.html", depends-on = ["coverage"] }
+tests-ci = { depends-on = ["tests-cov", "tests-vendor"] , description = "Run tests with coverage and vendor tests"}
+coverage = { cmd = "coverage html", depends-on = ["tests-cov"], description = "Generate test coverage html report"}
+open-coverage = { cmd = "open htmlcov/index.html", depends-on = ["coverage"] , description = "Open test coverage report"}
 
 [tool.pixi.feature.docs.dependencies]
 sphinx = ">=7.4.7"
@@ -111,14 +111,14 @@ typing-extensions = ">=4.13.1"
 numpy = ">=2.1.3"
 
 [tool.pixi.feature.docs.tasks]
-docs = { cmd = "sphinx-build -E -W . build/", cwd = "docs" }
-open-docs = { cmd = "open build/index.html", cwd = "docs", depends-on = ["docs"] }
+docs = { cmd = "sphinx-build -E -W . build/", cwd = "docs" , description = "Build docs"}
+open-docs = { cmd = "open build/index.html", cwd = "docs", depends-on = ["docs"] , description = "Open the generated docs"}
 
 [tool.pixi.feature.dev.dependencies]
 ipython = ">=7.33.0"
 
 [tool.pixi.feature.dev.tasks]
-ipython = { cmd = "ipython" }
+ipython = { cmd = "ipython" , description = "Launch ipython"}
 
 [tool.pixi.feature.py310.dependencies]
 python = "~=3.10.0"