Add basic doc string

mrpowers-io · Aug 24, 2024 · 899eea3 · 899eea3
1 parent 1d73486
commit 899eea3
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/src/main/scala/com/github/mrpowers/spark/fast/tests/DataFrameComparer.scala b/src/main/scala/com/github/mrpowers/spark/fast/tests/DataFrameComparer.scala
@@ -48,6 +48,9 @@ trait DataFrameComparer extends DatasetComparer {
     )
   }
 
+  /**
+   * Raises an error unless `actualDF` and `expectedDF` are equal
+   */
   def assertApproximateSmallDataFrameEquality(actualDF: DataFrame,
                                               expectedDF: DataFrame,
                                               precision: Double,
@@ -66,6 +69,9 @@ trait DataFrameComparer extends DatasetComparer {
     )
   }
 
+  /**
+   * Raises an error unless `actualDF` and `expectedDF` are equal
+   */
   def assertApproximateLargeDataFrameEquality(actualDF: DataFrame,
                                          expectedDF: DataFrame,
                                          precision: Double,