add comment on a test class

pantsbuild · Oct 15, 2020 · 0176f27 · 0176f27
1 parent 05cc019
commit 0176f27
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/src/python/pants/backend/pants_info/list_target_types_test.py b/src/python/pants/backend/pants_info/list_target_types_test.py
@@ -163,6 +163,8 @@ def test_list_all_json() -> None:
 
 
 def test_list_single() -> None:
+    # The reason we want this to still be TriBoolField is that we want to test that required = True
+    # results in stripping | None from the help message.
     class CustomField(TriBoolField):
         """My custom field!