speps / go-hashids

Go (golang) implementation of http://www.hashids.org
MIT License
1.32k stars 109 forks source link

Update doc comments #62

Open makupi opened 2 years ago

makupi commented 2 years ago

The documentation for the DecodeWithError functions currently don't reflect what the code actually does. When using DecodeWithError with a different MinLength the sanity check will fail, had to look at the actual code to figure out why that is happening because the comment said that MinLength has no effect, which is not correct.

The PR fixes the comments and mentions the sanity check which is done by the functions.