search

wialon / gmqtt

Python MQTT v5.0 async client
MIT License
385 stars 53 forks source link

Formal documentation for API #147

Open ppbrown opened 11 months ago

ppbrown commented 11 months ago

having examples is nice... but what would be even nicer, is having an official documentation of the API? Most other major python libraries I've used, have proper API documentation.

For example, I'd like to know how I'm expected to check if a client.publish()

call failed or not.

I've noticed that if the connection is closed, something randomly writes to terminal, [TRYING WRITE TO CLOSED SOCKET]

but I dont want things randomly writing to my terminal: I want my program to be able to detect the failed write, and do something sensible about it.

Lenka42 commented 11 months ago

@ppbrown agree :slightly_smiling_face: I will try to find time for this during august.