BewareMyPower commented on issue #85:
URL:
https://github.com/apache/pulsar-client-python/issues/85#issuecomment-1531652717
> in the subscribe section simply has a default value of
_pulsar.ConsumerType.Exclusive but no details on what other ConsumerTypes there
are.
It's an issue with the Python API docs generation for the `_pulsar` module,
which is a C++ wrapper written based on the PyBind11. It seems currently the
Python docs generation tool does not generate the docs for the `_pulsar`
module. /cc @tisonkun
On the other hand, PyBind11 support adding the Python API docs via the C++
code. Currently the docs were not good. For example, I typed
`help(_pulsar.ConsumerType)` and see:
```
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| Exclusive = <ConsumerType.Exclusive: 0>
|
| Failover = <ConsumerType.Failover: 2>
|
| KeyShared = <ConsumerType.KeyShared: 3>
|
| Shared = <ConsumerType.Shared: 1>
|
| ----------------------------------------------------------------------
| Static methods inherited from pybind11_builtins.pybind11_object:
|
| __new__(*args, **kwargs) from pybind11_builtins.pybind11_type
| Create and return a new object. See help(type) for accurate
signature.
```
We can enhance the API docs later.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
