apache / apache/pulsar-client-python

Document for the pulsar.Result enum

Open
#185 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
75
Forks
53
PR merge metrics
No merged PRs in 30d

Description

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.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.