[Bug]: Godoc comments are incorrect in bech32.go file

cosmos / cosmos-sdk

:chains: A Framework for Building High Value Public Blockchains :sparkles:

https://cosmos.network/

Apache License 2.0

6.23k stars 3.6k forks source link

[Bug]: Godoc comments are incorrect in bech32.go file #17494

Closed BrendanChou closed 12 months ago

BrendanChou commented 1 year ago

What happened?

In the godoc comments for bech32, wherever base64 is mentioned (implying 6 bits per byte), it is actually using base256 (all 8 bits in the byte). This is seen by the 8 being used as the argument to the underlying btcsuite/btcutil/bech32 functions.

Anywhere that base32 is mentioned is still correct.

Cosmos SDK Version

main

How to reproduce?

Note: Since these are godoc comments, this also results in the documentation being incorrect, not just the file-level comments

julienrbrt commented 1 year ago

Would you be up submitting a PR?