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

Added documentation for tls_set in README.md #128

Merged
merged 3 commits into from
Sep 2, 2022

Conversation

Sohaib90
Copy link
Contributor

@Sohaib90 Sohaib90 commented Sep 1, 2022

I just wanted to ask for improvements and suggestions when adding the recent changes to the README.md
If this is alright (for now, just tls_set example added) I can add the proxy settings as well

@frederikaalund
Copy link
Collaborator

Thank you for opening this PR. Let me have a look. :)

Looks good and I think that it will help our users with the recently-added functionality (thanks again on that part).

One minor nitpick: Let's send the example code through Black first. When that is done, I'll merge this. 👍

@Sohaib90
Copy link
Contributor Author

Sohaib90 commented Sep 1, 2022

Hmmm, do I have to use black on the README.md or just the example code part and then commit that?

@frederikaalund
Copy link
Collaborator

Just the example code, thanks. :) It formats python code in a standard way. IMHO, it's a good idea to run it on all python code that goes into this repo.

@Sohaib90
Copy link
Contributor Author

Sohaib90 commented Sep 1, 2022

Just added the formatted example code. If this is alright, I would also like to add the proxy_set information and commit that in this PR

@frederikaalund
Copy link
Collaborator

Looks great, thanks!

If this is alright, I would also like to add the proxy_set information and commit that in this PR

Please, by all means go ahead. :)

@Sohaib90
Copy link
Contributor Author

Sohaib90 commented Sep 2, 2022

@frederikaalund I have added the documentation for the proxy settings as well. It is complete now

@frederikaalund
Copy link
Collaborator

LGTM. This will definitely help our users since we were pretty light on the documentation beforehand. Thanks again for your contribution to asyncio-mqtt. 👍

@frederikaalund frederikaalund merged commit 69321b0 into empicano:master Sep 2, 2022
@Sohaib90 Sohaib90 deleted the document_proxy_tls branch September 2, 2022 09:10
@Sohaib90
Copy link
Contributor Author

Sohaib90 commented Sep 2, 2022

It was my pleasure :)
Might contribute in the future as well

@frederikaalund
Copy link
Collaborator

Looking forward to that. Thanks again! 👍

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

Successfully merging this pull request may close these issues.

2 participants