Notes on testing ignore_tables and TSK_CMP_IGNORE_TABLES

Author: clwgg

c/tests/test_tables.c

@@ -277,6 +277,8 @@ test_table_collection_equals_options(void)
     CU_ASSERT_FALSE(tsk_table_collection_equals(&tc1, &tc2, 0));
     CU_ASSERT_TRUE(tsk_table_collection_equals(&tc1, &tc2, TSK_CMP_IGNORE_METADATA));
 
+    // NOTE: test TSK_CMP_IGNORE_TABLES here too?
+
     tsk_table_collection_free(&tc1);
     tsk_table_collection_free(&tc2);
 }

python/tests/test_highlevel.py

@@ -2278,6 +2278,8 @@ def modify(ts, func):
         assert t1.equals(t2)
         assert t2.equals(t1)
 
+        # NOTE: test `ignore_tables` here too?
+
     def test_tree_node_edges(self):
         for ts in get_example_tree_sequences():
             edge_visited = np.zeros(ts.num_edges, dtype=bool)

python/tests/test_tables.py

@@ -4003,6 +4003,8 @@ def test_ignore_timestamps(self, t1, t2):
         t1.assert_equals(t2, ignore_provenance=True)
         t1.assert_equals(t2, ignore_timestamps=True)
 
+    # NOTE: test `ignore_tables` here too?
+
 
 class TestTableCollectionMethodSignatures:
     tc = msprime.simulate(10, random_seed=1234).dump_tables()

python/tskit/tables.py

@@ -2856,6 +2856,10 @@ def assert_equals(
                 f" differs: self={self.sequence_length} other={other.sequence_length}"
             )
 
+        # NOTE: Do we need to anything "extra" to account for `ignore_tables`?
+        # Currently, the difference between a TableCollection with and without
+        # tables gets caught by `AssertionError: EdgeTable number of rows
+        # differ:`.
         for table_name, table in self.name_map.items():
             if table_name != "provenances":
                 table.assert_equals(