描述
For some methods (e.g. pause), there are common causes of failure (e.g. nothing to pause) which result in specific error codes (e.g. UPnP Error 701). We should collect those error codes and document them together with their meaning in the docstring of each method.
Previous conversation about this topic on #454:
@KennethNielsen commented on 18 Jan 2017 on #454:
I can see in the source code that it is documented that e.g. play and pause may raise SoCoUPnPException, but it does not mention anything about the error code. It may be useful to add a little something to the docstrings about the most common sources of failures and about more acceptable sources of failures, such as this one. What do you think.
@ghcs27 commented on 18 Jan 2017 on #454:
I would support adding UPnP error codes and their meaning to the docs. The basic meaning of the error codes can be found on page 89 of the UPnP specs, but some codes probably have a Sonos specific meaning.
@KennethNielsen commented on 21 Jan 2017 on #454:
It might be that we should add some sort of list (probably not exhaustive though, but with links) somewhere in the docs, but my question was more whether it would be a good idea to explain one or 2 particularly relevant error codes in the doc string for methods like e.g. pause. Thoughts?