Document provided Codecs in lexy.go - Githubissues

phiryll / lexy

Lexicographical Byte Order Encodings

MIT License

0 stars 0 forks source link

Document provided Codecs in lexy.go #2

Open phiryll opened 2 weeks ago

phiryll commented 2 weeks ago

Document only what is necessary to use the Codec, not the details of the encoding. The documentation must include:

ordering, if not obvious
any departures from Codec's documentation, especially if the Codec is not lossless and invertible

https://github.com/phiryll/lexy/blob/48c55ee9c5c3662ad489190d24bd52002ac6b93d/lexy.go#L49-L66