honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

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.
This commit is contained in:
Robin Stocker 2017-03-17 02:39:45 +10:00 committed by Nik Everett
parent 8b6d521037
commit 6e9dfb3348
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/reference/api-conventions.asciidoc
View File

@ -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 parameter, the value must specify the unit, like `10kb` for 10 kilobytes. Note that
supported units are: these units use powers of 1024, so `1kb` means 1024 bytes. The supported units are:
[horizontal] [horizontal]
`b`:: Bytes `b`:: Bytes