What happened?

Some examples in the docstrings, like the example for frequenz.sdk.actor.power_distributing.PowerDistributingActor, are broken because they are not automatically tested.

What did you expect instead?

The examples should work.

Affected version(s)

v0.12.0

Affected part(s)

Documentation (part:docs)

Extra information

At some point we need to start testing docstrings. There are projects to do that, like:

• https://docs.python.org/3/library/doctest.html

• https://docs.pytest.org/en/7.1.x/how-to/doctest.html

• https://stackoverflow.com/questions/23250068/python-doctest-my-github-markdown-files

  • • https://pypi.org/project/phmdoctest/
  • • https://github.com/ryneeverett/mkcodes