uber/h3

Expose error messages strings via function in h3api.h

Offen

#591 geöffnet am 11.03.2022

Auf GitHub ansehenContributor Guide
 (0 Kommentare) (0 Reaktionen) (1 zugewiesene Person)C (585 Forks)github user discovery
help wanted

Repository-Metriken

Stars
 (6.310 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 7T 19h) (17 gemergte PRs in 30 T)

Beschreibung

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

Contributor Guide

Research-Richtung
Implementieren Sie die Funktion errorToString, die Fehlercodes basierend auf den Kommentaren in h3api.h Zeichenfolgen zuordnet. Fügen Sie Dokumentation hinzu und aktualisieren Sie die Website bei Bedarf.
Tech Stack
c
Domain
api
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
2
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
1-3 Stunden
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
C
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
75