Added "size units" to API conventions docs

This commit is contained in:
Clinton Gormley 2015-12-10 11:23:48 +01:00
parent fac8d97356
commit 9d71c7210b
1 changed files with 16 additions and 0 deletions

View File

@ -360,6 +360,22 @@ are:
`s`:: Second `s`:: Second
`ms`:: Milli-second `ms`:: Milli-second
[[size-units]]
[float]
=== Data size units
Whenever the size of data needs to be specified, eg when setting a buffer size
parameter, the value must specify the unit, like `10kb` for 10 kilobytes. The
supported units are:
[horizontal]
`b`:: Bytes
`kb`:: Kilobytes
`mb`:: Megabytes
`gb`:: Gigabytes
`tb`:: Terabytes
`pb`:: Petabytes
[[distance-units]] [[distance-units]]
[float] [float]
=== Distance Units === Distance Units