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

Publisher/Subscribe example also for JSON data and ProtocolVersion in the init #65

Merged
merged 3 commits into from
Jun 19, 2021

Conversation

tropxy
Copy link
Contributor

@tropxy tropxy commented Jun 18, 2021

docs: Added a Publisher example, how to handle with the Client arguments and added an example of how to deal with JSON data; included ProtocolVersion in the init.py so that we can directly summon the Enum from the package import

This addresses #63

…nts and added an example of how to deal with JSON data; included ProtocolVersion in the __init__.py so that we can directly summon the Enum from the package import
@frederikaalund
Copy link
Member

Looks good! 👍

I have two requests:

  • Let's move the examples to an /examples folder to not clutter README.md. I like to keep the readme simple. :)
  • I like the change to __init__.py. 👍 It's unrelated to the docs, though, so can you move it into a separate commit?

Does it make sense?

@tropxy
Copy link
Contributor Author

tropxy commented Jun 18, 2021

Yup, it all makes sense. I initially added an examples folder, but then usually one creates python scripts to exemplify whatever is the use case you trying to exemplify and in this case I thought it is just easier to show in a Markdown file how it works and add comments there as necessary. Do you think it would make sense to create an Examples.md? Or you really prefer to have scripts?

@frederikaalund
Copy link
Member

Both .py and .md works for me. 👍 Whatever you prefer. This is the start of the documentation that we don't currently have. :))

…f how to handle JSON data; Reverted the ProtocolVersion usage in the __init__.py for separation of concerns purposes (it will be addressed in a separate commit)
@tropxy
Copy link
Contributor Author

tropxy commented Jun 18, 2021

Both .py and .md works for me. 👍 Whatever you prefer. This is the start of the documentation that we don't currently have. :))

I hope it looks better now

@frederikaalund frederikaalund merged commit 63000ca into sbtinstruments:master Jun 19, 2021
@frederikaalund
Copy link
Member

Looks good to me. Thanks for your contribution to asyncio-mqtt. :) 👍

@tropxy
Copy link
Contributor Author

tropxy commented Jun 21, 2021

My pleasure! I hope we can do like a proper doc page in the future ;)

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.

None yet

2 participants