confluentinc / confluent-kafka-python

Confluent's Kafka Python Client
http://docs.confluent.io/current/clients/confluent-kafka-python
Other
3.73k stars 882 forks source link

Adjust function name in docs for Message.__len__ function #1693

Closed hcmturner closed 5 months ago

hcmturner commented 6 months ago

The docs currently describe a Message.len() method. This method does not exist, the method implemented is the normal Message.len method, which then provides len(Message). Change is to rename the function in the docs to len so that it is clear that the built in len method is the one being created.

Caught me out recently, and has previously caught someone out: https://github.com/confluentinc/confluent-kafka-python/issues/1142

cla-assistant[bot] commented 6 months ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Henry Turner seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

cla-assistant[bot] commented 6 months ago

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


Henry Turner seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.