浏览代码

Added "size units" to API conventions docs

Clinton Gormley 10 年之前
父节点
当前提交
9d71c7210b
共有 1 个文件被更改,包括 16 次插入0 次删除
  1. 16 0
      docs/reference/api-conventions.asciidoc

+ 16 - 0
docs/reference/api-conventions.asciidoc

@@ -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