uber/h3

Expose error messages strings via function in h3api.h

Aberta

#591 aberto em 11 de mar. de 2022

Ver no GitHubGuia do colaborador
 (0 comentário) (0 reação) (1 responsável)C (585 forks)github user discovery
help wanted

Métricas do repositório

Stars
 (6.310 estrelas)
Métricas de merge de PR
 (Mesclagem média 7d 19h) (17 fundiu PRs em 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

Guia do colaborador

Direção de pesquisa
Implemente a função errorToString que mapeia códigos de erro para strings com base nos comentários em h3api.h. Adicione documentação e atualize o site se necessário.
Pilha de tecnologia
c
Domain
api
Tipo Issue
Funcionalidade
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
C
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
75