search

loadout-ink / splat2-calc

Gear planning tool for Splatoon 2.
MIT License
112 stars 30 forks source link

Add documentation about encoding mechanism #10

Closed Leward closed 7 years ago

Leward commented 7 years ago

I went through the code and the encoding part was a bit hard to figure out how it worked. I wrote some comments to help me out, I think they may be helpful to anyone who goes through this file.

DeviPotato commented 7 years ago

Thanks for writing this up! It's almost completely correct - the first digit is a version number, in case I ever have to change the encoding method in the future - that way I can remain backwards compatible simply by checking the version number.

This has made me realize I should probably do a pass to document and comment my code in general. Great work here - it's very easy to read.

I'll be merging this once I can make the "version number" tweak.

Leward commented 7 years ago

I added some details explaining what you just said about the version number.