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

docs(uat): update comments for proper doc generation #393

Conversation

eschastlivtsev
Copy link

Issue #, if available:
Prepare documentation for the client (Paho Python)

Description of changes:

  • Update comments to Google-style python docstrings
  • Update README.md

Why is this change necessary:
It allow generate documentation for Paho Python client by run pdoc3

How was this change tested:
Documentation generation - manually.

Any additional information or context required to review the change:

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

@jcosentino11 jcosentino11 merged commit 186b06e into aws-greengrass:uat-dev Aug 9, 2023
6 of 8 checks passed
@bgklika bgklika deleted the GGMQ-287-prepare-documentation-for-the-client-paho-python branch August 25, 2023 12:33
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