Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Formal documentation for API #147

Open
ppbrown opened this issue Jul 31, 2023 · 1 comment
Open

Formal documentation for API #147

ppbrown opened this issue Jul 31, 2023 · 1 comment

Comments

@ppbrown
Copy link

ppbrown commented Jul 31, 2023

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
Copy link
Collaborator

Lenka42 commented Aug 1, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants