Iterator and IteratorBytes properties are not explained

romshark / jscan

High performance JSON iterator & validator for Go

BSD 3-Clause "New" or "Revised" License

88 stars 7 forks source link

Closed dolmen closed 1 year ago

dolmen commented 1 year ago

The properties of types jscan.Iterator and jscan.IteratorBytes lack comment describing what they means.

If KeyStart, KeyEnd, ValueStart, ValueEnd are byte offsets relative to s given to jscan.ScanBytes, that should be explicitely mentioned.

romshark commented 1 year ago

I agree. There's room for improvement in the documentation.