more comments

Author: 31puneet

malariagen_data/anoph/distance.py

@@ -119,10 +119,15 @@ def biallelic_diplotype_pairwise_distances(
         # invalidate any previously cached data.
         name = "biallelic_diplotype_pairwise_distances"
 
+        # Check that either sample_query xor sample_indices are provided.
         base_params._validate_sample_selection_params(
             sample_query=sample_query, sample_indices=sample_indices
         )
 
+        ## Normalize params for consistent hash value.
+
+        # Note: `_prep_sample_selection_cache_params` converts `sample_query` and `sample_query_options` into `sample_indices`.
+        # So `sample_query` and `sample_query_options` should not be used beyond this point. (`sample_indices` should be used instead.)
         (
             sample_sets_prepped,
             sample_indices_prepped,

malariagen_data/anoph/snp_data.py

@@ -1922,6 +1922,7 @@ def biallelic_snp_calls(
         n_snps: Optional[base_params.n_snps] = None,
         thin_offset: base_params.thin_offset = 0,
     ) -> xr.Dataset:
+        # Check that either sample_query xor sample_indices are provided.
         base_params._validate_sample_selection_params(
             sample_query=sample_query, sample_indices=sample_indices
         )