[Docs] Clarify numeric datatype ranges (#28240)

Since #25826 we reject infinite values for float, double and half_float
datatypes. This change adds this restriction to the documentation for the
supported datatypes.

Closes #27653
This commit is contained in:
Christoph Büscher 2018-01-16 15:53:28 +01:00 committed by GitHub
parent 4f5be7db3c
commit d4ac0026fc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 3 deletions

View File

@ -8,9 +8,9 @@ The following numeric types are supported:
`integer`:: A signed 32-bit integer with a minimum value of +-2^31^+ and a maximum value of +2^31^-1+. `integer`:: A signed 32-bit integer with a minimum value of +-2^31^+ and a maximum value of +2^31^-1+.
`short`:: A signed 16-bit integer with a minimum value of +-32,768+ and a maximum value of +32,767+. `short`:: A signed 16-bit integer with a minimum value of +-32,768+ and a maximum value of +32,767+.
`byte`:: A signed 8-bit integer with a minimum value of +-128+ and a maximum value of +127+. `byte`:: A signed 8-bit integer with a minimum value of +-128+ and a maximum value of +127+.
`double`:: A double-precision 64-bit IEEE 754 floating point number. `double`:: A double-precision 64-bit IEEE 754 floating point number, restricted to finite values.
`float`:: A single-precision 32-bit IEEE 754 floating point number. `float`:: A single-precision 32-bit IEEE 754 floating point number, restricted to finite values.
`half_float`:: A half-precision 16-bit IEEE 754 floating point number. `half_float`:: A half-precision 16-bit IEEE 754 floating point number, restricted to finite values.
`scaled_float`:: A floating point number that is backed by a `long`, scaled by a fixed `double` scaling factor. `scaled_float`:: A floating point number that is backed by a `long`, scaled by a fixed `double` scaling factor.
Below is an example of configuring a mapping with numeric fields: Below is an example of configuring a mapping with numeric fields: