pyatv icon indicating copy to clipboard operation
pyatv copied to clipboard

Fully document expected interface behavior

Open postlund opened this issue 4 years ago • 0 comments

Short feature/function description

It's currently not possible to know how various methods in the interface behaves, e.g. is it blocking, what exceptions are potentially raised, protocol specific details, etc. I need to take some time and document this as well as update protocol implementations that does not match expected behavior.

What needs to be done?

I need to look at the methods from the perspective of how I would like them to work but also what the protocols allow themselves.

Is this a breaking change?

Should not be a breaking change, but I might have to make minor adjustments to how things are implemented in the protocols that alter behavior.

Anything else worth knowing?

No

postlund avatar Dec 22 '21 11:12 postlund