apache / apache/pulsar-client-python

Document for the pulsar.Result enum

Aperta
#185 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
Python
Stelle
75
Fork
53
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

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.

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia in pulsar/__init__.py, intorno all’import alla riga 50, quindi confronta i valori dell’enum con i significati del C++ include/pulsar/Result.h collegato. Documenta i significati dei codici di errore dell’enum pulsar.Result rivolto a Python, in modo che gli utenti possano comprendere e gestire ogni risultato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
2/5
Tempo stimato
1-3 ore
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
52/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.