Fix typo and improve readability of workflow documentation

PiperOrigin-RevId: 718687264
jax-ml · Jan 23, 2025 · c71104b · c71104b
1 parent 6f60992
commit c71104b
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 18 deletions.
diff --git a/.github/workflows/wheel_tests_continuous.yml b/.github/workflows/wheel_tests_continuous.yml
@@ -5,15 +5,15 @@
 # It orchestrates the following:
 # 1. build-jaxlib-artifact: Calls the `build_artifacts.yml` workflow to build jaxlib and
 #                           uploads it to a GCS bucket.
-# 2. run-pytest-cpu: Calls the `pytest_cpu.yml` workflow to download the jaxlib wheel that was built
-#                    in the previous step and runs CPU tests.
-# 3. build-cuda-artifacts: Calls the `build_artifacts.yml` workflow to build CUDA artifacts and
-#                          uploads them to a GCS bucket.
-# 4. run-pytest-cuda: Calls the `pytest_cuda.yml` workflow to download the jaxlib and CUDA artifacts
-#                     that were built in the previous steps and runs the CUDA tests.
-# 5. run-bazel-test-cuda: Calls the `bazel_cuda_non_rbe.yml` workflow to download the jaxlib and
-#                         CUDA artifacts that were built in the previous steps and runs the CUDA
-#                         tests using Bazel.
+# 2. run-pytest-cpu:        Calls the `pytest_cpu.yml` workflow which downloads the jaxlib wheel
+#                           that was built in the previous step and runs CPU tests.
+# 3. build-cuda-artifacts:  Calls the `build_artifacts.yml` workflow to build CUDA artifacts and
+#                           uploads them to a GCS bucket.
+# 4. run-pytest-cuda:       Calls the `pytest_cuda.yml` workflow which downloads the jaxlib and CUDA
+#                           artifacts that were built in the previous steps and runs the CUDA tests.
+# 5. run-bazel-test-cuda:   Calls the `bazel_cuda_non_rbe.yml` workflow which downloads the jaxlib
+#                           and CUDA artifacts that were built in the previous steps and runs the
+#                           CUDA tests using Bazel.
 
 name: CI - Wheel Tests (Continuous)
 

diff --git a/.github/workflows/wheel_tests_nightly_release.yml b/.github/workflows/wheel_tests_nightly_release.yml
@@ -1,16 +1,12 @@
-# CI - Wheel Tests (Continuous)
+# CI - Wheel Tests (Nightly/Release)
 #
 # This workflow builds JAX artifacts and runs CPU/CUDA tests.
 #
 # It orchestrates the following:
-# 1. build-jaxlib-artifact: Calls the `build_artifacts.yml` workflow to build jaxlib and
-#                           uploads it to a GCS bucket.
-# 2. run-pytest-cpu: Calls the `pytest_cpu.yml` workflow to download the jaxlib wheel that was built
-#                    in the previous step and runs CPU tests.
-# 3. build-cuda-artifacts: Calls the `build_artifacts.yml` workflow to build CUDA artifacts and
-#                          uploads them to a GCS bucket.
-# 4. run-pytest-cuda: Calls the `pytest_cuda.yml` workflow to download the jaxlib and CUDA artifacts
-#                     that were built in the previous steps and runs the CUDA tests.
+# 1. run-pytest-cpu:  Calls the `pytest_cpu.yml` workflow which downloads the jaxlib wheel that was
+#                     built by internal CI jobs and runs CPU tests.
+# 2. run-pytest-cuda: Calls the `pytest_cuda.yml` workflow which downloads the jaxlib and CUDA
+#                     artifacts that were built by internal CI jobs and runs the CUDA tests.
 name: CI - Wheel Tests (Nightly/Release)
 
 on: