Skip to content

Commit 463678e

Browse files
robinstnik9000
authored andcommitted
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.
1 parent 0b49703 commit 463678e

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

docs/reference/api-conventions.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -507,8 +507,8 @@ the unit, like `2d` for 2 days. The supported units are:
507507
=== Byte size units
508508

509509
Whenever the byte size of data needs to be specified, eg when setting a buffer size
510-
parameter, the value must specify the unit, like `10kb` for 10 kilobytes. The
511-
supported units are:
510+
parameter, the value must specify the unit, like `10kb` for 10 kilobytes. Note that
511+
these units use powers of 1024, so `1kb` means 1024 bytes. The supported units are:
512512

513513
[horizontal]
514514
`b`:: Bytes

0 commit comments

Comments
 (0)