apache / apache/pulsar-client-python
Document for the pulsar.Result enum
- Linguagem predominante
- Python
- Estrelas
- 75
- Forks
- 53
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Descrição
The `pulsar.Result` enum is just imported from the C extension. See https://github.com/apache/pulsar-client-python/blob/daabc677e06e867f84beaeb3912d1d450cddf54d/pulsar/__init__.py#L50
Running `help(pulsar.Result)` could only show the underlying C error codes like
```
|
| AlreadyClosed =
|
| AuthenticationError =
|
| AuthorizationError =
|
| BrokerMetadataError =
|
| BrokerPersistenceError =
```
The error code should be well documented. Otherwise users might not know how to handle these error codes.
For now, users can refer https://github.com/apache/pulsar-client-cpp/blob/main/include/pulsar/Result.h for the meaning of error codes.
Guia de contribuição
Direção de pesquisa
Comece em pulsar/__init__.py, próximo ao import na linha 50, e depois compare os valores do enum com os significados no C++ include/pulsar/Result.h vinculado. Documente os significados dos códigos de erro do enum pulsar.Result voltado para Python para que os usuários possam entender e tratar cada resultado.
Escrita pelo modelo de indexação a partir do texto da issue.
Avaliação
- Stack de tecnologia
- python
- Domínio
- documentation
- Tipo de issue
- Documentação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Status de atividade
- Estagnada
- Clareza
- Razoavelmente clara
- Facilidade para iniciantes
- 52/100