Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

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

Closed
BrendanChou opened this issue Aug 21, 2023 · 1 comment · Fixed by #18114
Closed

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

BrendanChou opened this issue Aug 21, 2023 · 1 comment · Fixed by #18114
Labels
T:Docs Changes and features related to documentation.

Comments

@BrendanChou
Copy link

BrendanChou commented Aug 21, 2023 •
edited
Loading

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
@BrendanChou BrendanChou changed the title [Bug]: Comments are incorrect in bech32.go file [Bug]: Godoc comments are incorrect in bech32.go file Aug 21, 2023
@julienrbrt
Copy link
Member

Would you be up submitting a PR?

@julienrbrt julienrbrt added T:Docs Changes and features related to documentation. and removed T:Bug labels Aug 22, 2023
@tac0turtle tac0turtle mentioned this issue Oct 13, 2023
Merged
20 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
T:Docs Changes and features related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

chore: fix comments on bech32 cosmos/cosmos-sdk
2 participants
@BrendanChou @julienrbrt