Merge pull request #842 from GaloisInc/issue836

Add docstring for 'RoundingMode'. Fixes #836.
GaloisInc · Jul 28, 2020 · 1a2456a · 1a2456a
2 parents cf57a0f + b9eb076
commit 1a2456a
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/lib/Float.cry b/lib/Float.cry
@@ -27,6 +27,17 @@ type Float256 = Float 19 237
  * Rounding modes (this should be an enumeration type, when we add these)
  *---------------------------------------------------------------------- */
 
+/**
+ * A 'RoundingMode' is used to specify the precise behavior of some
+ * floating point primitives.
+ *
+ * There are five valid 'RoundingMode' values:
+ *  * roundNearestEven
+ *  * roundNearestAway
+ *  * roundPositive
+ *  * roundNegative
+ *  * roundZero
+ */
 type RoundingMode = [3]
 
 /** Round toward nearest, ties go to even. */