Add docstrings that RoundFromZero requires Julia 1.8

JuliaLang · Sep 12, 2021 · 687f4c1 · 687f4c1
1 parent 57cc756
commit 687f4c1
Show file tree

Hide file tree

Showing 2 changed files with 15 additions and 1 deletion.
diff --git a/base/div.jl b/base/div.jl
@@ -14,6 +14,9 @@ without any intermediate rounding.
 
 See also [`fld`](@ref) and [`cld`](@ref), which are special cases of this function.
 
+!!! compat "Julia 1.8"
+    `RoundFromZero` requires at least Julia 1.8.
+
 # Examples:
 ```jldoctest
 julia> div(4, 3, RoundDown) # Matches fld(4, 3)
@@ -68,6 +71,9 @@ without any intermediate rounding.
   `[0, -y)` otherwise. The result may not be exact if `x` and `y` have the same sign, and
   `abs(x) < abs(y)`. See also [`RoundFromZero`](@ref).
 
+!!! compat "Julia 1.8"
+    `RoundFromZero` requires at least Julia 1.8.
+
 # Examples:
 ```jldoctest
 julia> x = 9; y = 4;

diff --git a/base/rounding.jl b/base/rounding.jl
@@ -40,6 +40,10 @@ Currently supported rounding modes are:
 - [`RoundFromZero`](@ref)
 - [`RoundUp`](@ref)
 - [`RoundDown`](@ref)
+
+!!! compat "Julia 1.8"
+    `RoundFromZero` requires at least Julia 1.8. Prior versions support
+    `RoundFromZero` for `BigFloat`s only.
 """
 struct RoundingMode{T} end
 
@@ -77,13 +81,17 @@ const RoundDown = RoundingMode{:Down}()
 
 Rounds away from zero.
 
+!!! compat "Julia 1.8"
+    `RoundFromZero` requires at least Julia 1.8. Prior versions support
+    `RoundFromZero` for `BigFloat`s only.
+
 # Examples
 ```jldoctest
 julia> BigFloat("1.0000000000000001", 5, RoundFromZero)
 1.06
 ```
 """
-const RoundFromZero = RoundingMode{:FromZero}() # mpfr only
+const RoundFromZero = RoundingMode{:FromZero}()
 
 """
     RoundNearestTiesAway