From 6e9dfb334889258ff9205004ed8a851e1bc67d83 Mon Sep 17 00:00:00 2001 From: Robin Stocker Date: Fri, 17 Mar 2017 02:39:45 +1000 Subject: [PATCH] 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. --- docs/reference/api-conventions.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index 21bd539a4ea..7176f885831 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -506,8 +506,8 @@ the unit, like `2d` for 2 days. The supported units are: === Byte size units 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] `b`:: Bytes