Make fill_g_ens_col! return a boolean

Author: ph-kev

ext/ensemble_builder.jl

@@ -120,7 +120,7 @@ end
                                     verbose = false)
 
 Fill the `col_idx`th of the G ensemble matrix from the `OutputVar` `var` and
-`ekp`.
+`ekp`. If it was successful, return `true`, otherwise, return `false`.
 
 It is assumed that the times or dates of a single `OutputVar` is a superset of
 the times or dates of one or more metadata in the minibatch.
@@ -170,7 +170,7 @@ function EnsembleBuilder.fill_g_ens_col!(
     use_var || @warn(
         "OutputVar with the short name $(ClimaAnalysis.short_name(var)) was passed as an input, but did not match with any of the metadata"
     )
-    return nothing
+    return use_var
 end
 
 """
@@ -180,6 +180,8 @@ end
 
 Fill the `col_idx`th column of the G ensemble matrix with `val`.
 
+This returns `true`.
+
 This is useful if you want to completely fill a column of a G ensemble matrix
 with `NaN`s if a simulation crashed.
 """
@@ -190,7 +192,7 @@ function EnsembleBuilder.fill_g_ens_col!(
 )
     g_ens_builder.g_ens[:, col_idx] .= val
     g_ens_builder.completed[:, col_idx] .= true
-    return nothing
+    return true
 end
 
 """

test/ensemble_builder.jl

@@ -355,12 +355,8 @@ end
         @test !EnsembleBuilder.is_complete(g_ens_builder)
         # Permute dimensions to test that the dimensions are permuted correctly
         # before flattening
-        EnsembleBuilder.fill_g_ens_col!(
-            g_ens_builder,
-            i,
-            time_var,
-        )
-        EnsembleBuilder.fill_g_ens_col!(
+        @test EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, time_var)
+        @test EnsembleBuilder.fill_g_ens_col!(
             g_ens_builder,
             i,
             permutedims(lon_var, ("time", "lon")),
@@ -387,8 +383,8 @@ end
     g_ens_builder = EnsembleBuilder.GEnsembleBuilder(eki)
     for i in 1:3
         @test !EnsembleBuilder.is_complete(g_ens_builder)
-        EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, time_var)
-        EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, lon_var)
+        @test EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, time_var)
+        @test EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, lon_var)
     end
     @test EnsembleBuilder.is_complete(g_ens_builder)
     flat_time_var = window_and_flatten(
@@ -411,7 +407,8 @@ end
     g_ens_builder = EnsembleBuilder.GEnsembleBuilder(eki)
     for i in 1:3
         @test !EnsembleBuilder.is_complete(g_ens_builder)
-        EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, time_var)
+        @test EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, time_var)
+        @test !EnsembleBuilder.fill_g_ens_col!(g_ens_builder, i, lon_var)
     end
     @test EnsembleBuilder.is_complete(g_ens_builder)
     flat_time_var = window_and_flatten(
@@ -524,7 +521,7 @@ end
     @test EnsembleBuilder.missing_short_names(g_ens_builder, 1) ==
           Set{String}(["hey", "hi"])
 
-    EnsembleBuilder.fill_g_ens_col!(g_ens_builder, 1, NaN32)
+    @test EnsembleBuilder.fill_g_ens_col!(g_ens_builder, 1, NaN32)
     @test all(isnan, g_ens_builder.g_ens[:, 1])
     @test all(g_ens_builder.completed[:, 1])
 end