浏览代码

Docs: Specify that byte units use powers of 1024 (#23574)

In SI units, "kilobyte" or "kB" would mean 1000 bytes, whereas "KiB" is
used for 1024. Add a note in `api-conventions.asciidoc` to clarify the
meaning in Elasticsearch.
Robin Stocker 8 年之前
父节点
当前提交
6e9dfb3348
共有 1 个文件被更改,包括 2 次插入2 次删除
  1. 2 2
      docs/reference/api-conventions.asciidoc

+ 2 - 2
docs/reference/api-conventions.asciidoc

@@ -506,8 +506,8 @@ the unit, like `2d` for 2 days.  The supported units are:
 === Byte size units
 === Byte size units
 
 
 Whenever the byte size of data needs to be specified, eg when setting a buffer size
 Whenever the byte 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:
+parameter, the value must specify the unit, like `10kb` for 10 kilobytes. Note that
+these units use powers of 1024, so `1kb` means 1024 bytes. The supported units are:
 
 
 [horizontal]
 [horizontal]
 `b`::   Bytes
 `b`::   Bytes