mapbox / mapbox/osmpbf-tutorial

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

Ouverte
#4 1 commentaire 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Langage dominant
Aucune donnée de langage
Étoiles
23
Forks
3
Métriques de merge des PR
Aucune PR mergée en 30 j

Description

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

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

L’issue ne nomme aucun fichier ni aucun test. Repérez la section du tutoriel qui explique fieldwire et size, puis documentez-y que les numéros de champ supérieurs à 15 utilisent un octet varint supplémentaire, en prenant writingprogram (16) et source (17) comme exemples. Le travail est terminé lorsque l’octet supplémentaire et le comportement du décodage sont clairs pour les lecteurs.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Domaine
documentation
Type d'issue
Documentation
Difficulté
2/5
Temps estimé
1-3 heures
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
45/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.