Express sizes in more human-readable form?

[cormullion]

Congratulations on Documenter 1.0 - I've been using it without issues for various packages. It's awesome!

I think that this output:

could be made better if the "bytes" were converted to something more familiar. These days I'd be happy with MB, but KB could be OK. And perhaps it could be rounded to the nearest sensible amount, the precision here seems unnecessary (and we'd avoid the Kibibytes versus Kilobytes issue too).

[mortenpi]

Yeah, absolutely. I was just too lazy to implement it 🙂

[mortenpi]

The only thing is that there is a bit of range to the values, so I think it should pick the appropriate unit based on the order of magnitude (don't need to worry about anything other than B, KiB and MiB though).

[Hetarth02]

I would be happy to contribute.

@mortenpi Can you guide me, what we want to achieve(display in kb, mb, etc.) and where should I start looking?

[mortenpi]

@Hetarth02 The relevant line of code should be here:

Documenter.jl/src/html/HTMLWriter.jl

Lines 1771 to 1776 in 5dafb64

	size_threshold_msg(var::Symbol) = """
	Generated HTML over $(var) limit: $(navnode.page)
	Generated file size: $(file_size) (bytes)
	size_threshold_warn: $(ctx.settings.size_threshold_warn) (bytes)
	size_threshold: $(ctx.settings.size_threshold) (bytes)
	HTML file: $(page_path)"""

And as far as what we want to achieve: make sure that it prints the file sizes in B, KiB and MiB as appropriate. No need to support GiB and bigger, since if the user has pages that big, they have bigger problems.

[cormullion]

9223372036854775807 was the worst one 😂

[mortenpi]

9223372036854775807 was the worst one 😂

That probably needs to be special cased though. I'm using typemax(Int) to indicate "no limit".

Documenter.jl/src/html/HTMLWriter.jl

Line 524 in 5dafb64

size_threshold = typemax(Int)

[mortenpi]

#2344

[cormullion]

Thanks!