add explicit comments for int_to_bytes and bytes_to_int

[djrtwo]

Addresses #1395.
@mratsim is this what you meant? It seems a bit verbose as the initial header comment generally says the same thing. Can you remind me what exactly your issue was?

[JustinDrake]

the initial header comment generally says the same thing

Agreed 😂

Also note that every """ comments are currently one-liners. There's no need to break this pattern, especially for such simple helper functions.

[mratsim]

I think the best would be to give an example, for example, int_to_bytes(1, little_endian) returns 0x01000000...00000000

In our case we were padding the wrong way, i.e. something like this (exact location in byte 8 from the end)

0x00000000...01000000

[dankrad]

I also feel like the naming of the functions and parameters makes their behaviour very obvious. And I am usually in favour of more verbosity.

I think the best would be to give an example, for example, int_to_bytes(1, little_endian) returns 0x01000000...00000000

I don't understand this, it's not a padding problem. Little endian literally means that the least significant byte comes first, so how was it confusing?

[djrtwo]

adjusted the comment to mention the endian-ness, but moved back to a 1-liner