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

Documentation for the samples #65

Open
hame-c8y opened this issue Jan 20, 2025 · 0 comments
Open

Documentation for the samples #65

hame-c8y opened this issue Jan 20, 2025 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@hame-c8y
Copy link
Collaborator

At the moment the only documentation for the samples here:
https://github.com/Cumulocity-IoT/cumulocity-python-api/tree/main/samples

is the name of the Python file and the inline comments.

It would be good to either have Markdown file in the samples directory giving a brief summary of each sample or to have a comment block at the beginning of each sample explaining the sample as a whole.

@hame-c8y hame-c8y added the documentation Improvements or additions to documentation label Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant