uber/h3

Expose error messages strings via function in h3api.h

Ouverte

#591 ouverte le 11 mars 2022

Voir sur GitHubGuide contributeur
 (0 commentaire) (0 réaction) (1 personne assignée)C (585 forks)github user discovery
help wanted

Métriques du dépôt

Stars
 (6 310 étoiles)
Métriques de merge PR
 (Merge moyen 7j 19h) (17 PRs mergées en 30 j)

Description

Expose error message strings (which are currently given as comments in h3api.h), mainly so that the bindings can forward those explanations to users, without having to manually copy the messages.

Some examples in other projects:

Other notes:

  • Also needs to be added to our documentation
  • probably English only for now
  • const char *errorToString(H3Error err);
  • Eventually we could have the website build the error table from this function too

Guide contributeur

Direction de recherche
Implémentez la fonction errorToString qui mappe les codes d'erreur aux chaînes en fonction des commentaires dans h3api.h. Ajoutez la documentation et mettez à jour le site Web si nécessaire.
Stack technique
c
Domaine
api
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
Active
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
C
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
75