Skip to content

Commit 8ec0891

Browse files
committed
Add AutoFloat docstring
1 parent 51e46d6 commit 8ec0891

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

src/lazy_float.jl

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
1-
# This is used to store floats without forcing promotion on other
2-
# numeric types.
1+
"""
2+
AutoFloat <: AbstractFloat
3+
4+
A wrapper around a `Float64` which automatically demotes
5+
itself to `Float32` or `Float16` if interacting with
6+
such a type. In other cases it will respect promotion
7+
rules associated with `Float64`.
8+
"""
39
struct AutoFloat <: AbstractFloat
410
value::Float64
511

0 commit comments

Comments
 (0)