Add doc comments to Math constants

crystal-lang · Jan 2, 2021 · b456fb3 · b456fb3
1 parent ab8f915
commit b456fb3
Showing 1 changed file with 5 additions and 3 deletions.
diff --git a/src/math/math.cr b/src/math/math.cr
@@ -2,9 +2,11 @@ require "./libm"
 
 module Math
   extend self
-
-  PI    =  3.14159265358979323846
-  TAU   = 6.283185307179586476925
+  # Archimedes' constant (π).
+  PI = 3.14159265358979323846
+  # The full circle constant (τ), equal to 2π.
+  TAU = 6.283185307179586476925
+  # Euler's number (e).
   E     = LibM.exp_f64(1.0)
   LOG2  = LibM.log_f64(2.0)
   LOG10 = LibM.log_f64(10.0)