From 2244c9790f99ee688c49e9f11540334676bcc9f6 Mon Sep 17 00:00:00 2001
From: Roger Yang <80478925+RogerHYang@users.noreply.github.com>
Date: Wed, 23 Oct 2024 11:25:40 -0700
Subject: [PATCH] chore: add descriptions for `tox list` (#5169)

---
 tox.ini | 17 ++++++++++++++++-
 1 file changed, 16 insertions(+), 1 deletion(-)

diff --git a/tox.ini b/tox.ini
index 106ed7c5c3..ca96e227eb 100644
--- a/tox.ini
+++ b/tox.ini
@@ -7,6 +7,7 @@ package = wheel
 wheel_build_env = .pkg
 
 [testenv:phoenix_evals]
+description = Run tests for the arize-phoenix-evals package
 changedir = packages/phoenix-evals/
 deps =
   -r requirements/ci.txt
@@ -17,6 +18,7 @@ commands =
   pytest -ra -x {posargs:.}
 
 [testenv:phoenix_otel]
+description = Run tests for the arize-phoenix-otel package
 changedir = packages/phoenix-otel/
 deps =
   -r requirements/ci.txt
@@ -27,6 +29,7 @@ commands =
   ; pytest -ra -x {posargs:.}
 
 [testenv:type_check_integration_tests]
+description = Run type checking with mypy on integration tests
 changedir = tests/integration
 deps =
   -r requirements/integration-tests.txt
@@ -37,6 +40,7 @@ commands =
   mypy {posargs:.}
 
 [testenv:integration_tests]
+description = Run integration tests
 pass_env =
   CI_TEST_DB_BACKEND
 changedir = tests/integration
@@ -49,6 +53,7 @@ commands =
   pytest {posargs:.}
 
 [testenv:type_check_unit_tests]
+description = Run type checking with mypy on unit tests
 changedir = tests/
 deps =
   -r requirements/unit-tests.txt
@@ -59,6 +64,7 @@ commands =
   mypy {posargs:.}
 
 [testenv:unit_tests]
+description = Run unit tests
 changedir = tests
 deps =
   -r requirements/unit-tests.txt
@@ -69,15 +75,17 @@ commands =
   pytest --ignore=integration {posargs:.}
 
 [testenv:type_check]
+description = Run type checking with mypy on src/phoenix
 deps =
   -r requirements/type-check.txt
 commands_pre =
   uv pip install --strict --reinstall-package arize-phoenix .
 commands =
   uv pip list -v
-  mypy {posargs:.}
+  mypy {posargs:src/phoenix}
 
 [testenv:clean_jupyter_notebooks]
+description = Clear output and metadata from Jupyter notebooks
 deps =
   -r requirements/clean-jupyter-notebooks.txt
 commands =
@@ -85,6 +93,7 @@ commands =
   jupyter nbconvert --ClearOutputPreprocessor.enabled=True --ClearMetadataPreprocessor.enabled=True --inplace {posargs}
 
 [testenv:build_graphql_schema]
+description = Export GraphQL schema to a file
 changedir = app
 deps =
   -r requirements/build-graphql-schema.txt
@@ -95,6 +104,7 @@ commands =
   strawberry export-schema phoenix.server.api.schema:schema -o schema.graphql
 
 [testenv:build_openapi_schema]
+description = Export OpenAPI schema to a file
 changedir = schemas
 commands_pre =
   uv pip install --strict --reinstall-package arize-phoenix ../.
@@ -103,6 +113,7 @@ commands =
   python -m phoenix.server.api.openapi.main -o openapi.json
 
 [testenv:compile_protobuf]
+description = Compile protobuf files
 deps =
   -r requirements/compile-protobuf.txt
 commands =
@@ -110,6 +121,7 @@ commands =
   python -m grpc_tools.protoc -I src/phoenix/proto --python_out=src/phoenix --mypy_out=src/phoenix src/phoenix/proto/trace/v1/evaluation.proto
 
 [testenv:add_symlinks]
+description = Add symlinks to packages (for editable install)
 changedir = src/phoenix
 allowlist_externals =
   sh
@@ -118,6 +130,7 @@ commands =
   sh -c '[ -e otel ] || ln -s ../../packages/phoenix-otel/src/phoenix/otel otel'
 
 [testenv:remove_symlinks]
+description = Remove symlinks to packages
 changedir = src/phoenix
 allowlist_externals =
   unlink
@@ -126,6 +139,7 @@ commands =
   unlink otel
 
 [testenv:phoenix_main]
+description = Run Phoenix server
 pass_env=
   PHOENIX_PORT
   PHOENIX_GRPC_PORT
@@ -141,6 +155,7 @@ commands =
   uv tool run arize-phoenix {posargs:serve}
 
 [testenv:ruff]
+description = Run ruff for formatting and linting
 commands_pre =
   uv tool install ruff@0.7.0
 commands =