readme: note that some constants are not known to be irrational (#34)

* readme: note that some constants are not known to be irrational xref JuliaLang/julia#55897 * rationality -> irrationality Co-authored-by: David Widmann <[email protected]> --------- Co-authored-by: David Widmann <[email protected]>
JuliaMath · Sep 27, 2024 · 872ace5 · 872ace5
1 parent 97aa7da
commit 872ace5
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [![Coverage](https://codecov.io/gh/JuliaMath/IrrationalConstants.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/JuliaMath/IrrationalConstants.jl)
 [![Coverage](https://coveralls.io/repos/github/JuliaMath/IrrationalConstants.jl/badge.svg?branch=main)](https://coveralls.io/github/JuliaMath/IrrationalConstants.jl?branch=main)
 
-This package defines the following irrational constants:
+This package defines the following `AbstractIrrational` constants:
 
 ```julia
 twoπ       # 2π
@@ -33,3 +33,4 @@ log2π      # log(2π)
 log4π      # log(4π)
 ```
 
+Pedantic note: even though these constants are instances of `AbstractIrrational`, the irrationality of some of them is not known. This is the case, for example, with `logπ`.