mapbox / mapbox/osmpbf-tutorial

Warn about the multiple bytes fields (writingprogram, source, osmosis_replication_*...)

Aperta
#4 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Nessun dato sulla lingua
Stelle
23
Fork
3
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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 ;)

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

L’issue non indica alcun file né alcun test. Individua la sezione del tutorial che spiega fieldwire e size, quindi documenta che i numeri di campo superiori a 15 usano un byte varint aggiuntivo, usando writingprogram (16) e source (17) come esempi. Il lavoro è completato quando il byte aggiuntivo e il comportamento della decodifica sono chiari per i lettori.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.