Skip to content

Commit

Permalink
doc: MathConstants: add admonitions noting unknown rationality
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
nsajko committed Nov 23, 2024
1 parent 0bedaae commit e5efa0b
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions base/mathconstants.jl
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,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
Expand Down Expand Up @@ -123,6 +127,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
Expand Down

0 comments on commit e5efa0b

Please sign in to comment.