uber/h3

Expose error messages strings via function in h3api.h

Open

#591 opened on Mar 11, 2022

View on GitHubContributor guide
 (0 comments) (0 reactions) (1 assignee)C (585 forks)github user discovery
help wanted

Repository metrics

Stars
 (6,310 stars)
PR merge metrics
 (Avg merge 7d 19h) (17 merged PRs in 30d)

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

Contributor guide

Research direction
Implement the errorToString function that maps error codes to strings based on the comments in h3api.h. Add documentation and update website if necessary.
Tech stack
c
Domain
api
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
C
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75