mapbox / mapbox/osmpbf-tutorial
Warn about the multiple bytes fields (writingprogram, source, osmosis_replication_*...)
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 23
- Forks
- 3
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
Hello,
I think it could be good to warn when a field number exceeds 15, it needs more bytes to be encoded exactly like varints.
It happens for example on the writingprogram field ( = 16) which is encoded on two bytes 0x82 0x01.
MSB here is reserved to indicate the value also encoded on the next byte.
Decoding it like a varint is the way.
Also on source field ( = 17), and basically every field number greater than 15.
It personnaly took a while to understand why there was another byte between fieldwire and size and I think it'll be great to write it down to help a byte more ;)
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Das Issue nennt keine Datei und keinen Test. Finde den Tutorial-Abschnitt, der fieldwire und size erklärt, und dokumentiere dort, dass Feldnummern über 15 ein zusätzliches varint-Byte verwenden, wobei writingprogram (16) und source (17) als Beispiele dienen. Erledigt ist die Aufgabe, wenn das zusätzliche Byte und das Dekodierungsverhalten für Leser klar sind.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 2/5
- Geschätzter Aufwand
- 1-3 Stunden
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100