Skip to content

Missleading documentation: disk_size is in MiB not in MB #348

@lindhe

Description

@lindhe

Overview of the Issue

In the docs, it says for disk_size that the value is "The size of the disk in MB":

docs

It is in fact in MiB (1 048 576 bytes) not MB (1 000 000 bytes). It may seem like a minor detail, but these things are important. Trusting the documentation to be correct, I spent hours debugging why the disk size was incorrect for me. I do grant you that MB is not 100% wrong, just ambiguous, because of the legacy of the term. But since we can use a more correct term now, I think we should.

More occurrences

I have a hard time pin-pointing the exact line in this GitHub repo, but there are a handful of lines like this one:

"The size of the disk in MB" strings in this repo


- `disk_size` (int64) - The size of the disk in MB.

- `disk_size` (int64) - The size of the disk in MB.

- `disk_size` (int64) - The size of the disk in MB.

// The size of the disk in MB.

- `disk_size` (int64) - The size of the disk in MB.

- `disk_size` (int64) - The size of the disk in MB.

I do not know if all of these are incorrect, or if some of them are actually in MB. That should be investigated before changing them.

Multiple-byte units

For more information about the binary and decimal unit prefixes, please see https://en.wikipedia.org/wiki/Byte#Multiple-byte_units

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentation

Type

No type

Projects

No projects

Milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions