charmed-kubernetes / pytest-operator

Apache License 2.0
6 stars 13 forks source link

Add reference docs #21

Closed johnsca closed 2 years ago

johnsca commented 2 years ago

Ideally these would be auto-generated from the Python code and doc-strings, but I couldn't come up with a clean way to do that.

johnsca commented 2 years ago

There's already a minimal example in the README. This was specifically for adding the more detailed reference to document everything that the plugin does.

johnsca commented 2 years ago

The test failure is caused is caused by #23 and shouldn't block this PR.