add documentation to regime table test

astrodbtoolkit · Jul 9, 2024 · d452a61 · d452a61
1 parent 3a23578
commit d452a61
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/tests/test_schema.py b/tests/test_schema.py
@@ -127,6 +127,9 @@ def test_instruments_schema(values, error_state):
                             ({"regime": "ThisIsASuperLongInstrumentNameThatIsInvalid!!!!!!!"}, ValueError)
                           ])
 def test_instruments_schema(values, error_state):
+    """
+    In the schema, there is a validation that makes sure that the length of the regime is less than 30 characters.
+    """
     schema_tester(Regimes, values, error_state)