doc: MathConstants: add admonitions noting unknown rationality

Some of the `Irrational` constants are not known to be irrational, so it'd be good to note that in the doc string of each such constant to avoid being misleading.
JuliaLang · Sep 26, 2024 · dc6f851 · dc6f851
1 parent e4b29f7
commit dc6f851
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/base/mathconstants.jl b/base/mathconstants.jl
@@ -68,6 +68,10 @@ true
 
 Euler's constant.
 
+!!! note
+    Even though `MathConstants.γ isa Irrational`, it is not actually known
+    whether Euler's constant is rational.
+
 # Examples
 ```jldoctest
 julia> Base.MathConstants.eulergamma
@@ -103,6 +107,10 @@ true
 
 Catalan's constant.
 
+!!! note
+    Even though `MathConstants.catalan isa Irrational`, it is not actually known
+    whether Catalan's constant is rational.
+
 # Examples
 ```jldoctest
 julia> Base.MathConstants.catalan