Skip to content

Commit

Permalink
Docs: TwicePrecision is an internal type (#42863)
Browse files Browse the repository at this point in the history
Fixes #42857
  • Loading branch information
timholy authored Nov 4, 2021
1 parent 486c8de commit d00d457
Showing 1 changed file with 12 additions and 1 deletion.
13 changes: 12 additions & 1 deletion base/twiceprecision.jl
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,18 @@ div12(x, y) = div12(promote(x, y)...)
TwicePrecision{T}((num, denom))
A number with twice the precision of `T`, e.g., quad-precision if `T =
Float64`. `hi` represents the high bits (most significant bits) and
Float64`.
!!! warn
`TwicePrecision` is an internal type used to increase the
precision of floating-point ranges, and not intended for external use.
If you encounter them in real code, the most likely explanation is
that you are directly accessing the fields of a range. Use
the function interface instead, `step(r)` rather than `r.step`
# Extended help
`hi` represents the high bits (most significant bits) and
`lo` the low bits (least significant bits). Rational values
`num//denom` can be approximated conveniently using the syntax
`TwicePrecision{T}((num, denom))`.
Expand Down

2 comments on commit d00d457

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Executing the daily package evaluation, I will reply here when finished:

@nanosoldier runtests(ALL, isdaily = true)

@nanosoldier
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Your package evaluation job has completed - possible new issues were detected. A full report can be found here.

Please sign in to comment.