fix comment describing behavior of run() method

pantsbuild · Aug 18, 2018 · da7eefb · da7eefb
1 parent fc6ffc5
commit da7eefb
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/python/pants/backend/python/tasks/build_local_python_distributions.py b/src/python/pants/backend/python/tasks/build_local_python_distributions.py
@@ -307,7 +307,8 @@ def _create_dist(self, dist_tgt, dist_target_dir, interpreter,
 
     setup_py_env = setup_py_execution_environment.as_environment()
     with environment_as(**setup_py_env):
-      # Build a whl using SetupPyRunner and return its absolute path.
+      # Build a whl using SetupPyRunner. If the install was unsuccessful,
+      # SetupPyRunner.SetupPyRunnerError will be thrown.
       try:
         setup_runner.run()
       except SetupPyRunner.SetupPyRunnerError as e: