Enhance mpd player bindings documentation

Give some hints to install compatible `mpd` Python module, and rewrite to show
that the Python package is preferred (for example player status isn't supported
properly via `mpc` command).
This commit is contained in:
Werner Beroux 2015-05-19 14:57:54 +02:00 committed by Foo
parent bf6191d144
commit cc7f21221a
1 changed files with 8 additions and 1 deletions

View File

@ -208,7 +208,14 @@ class MpdPlayerSegment(PlayerSegment):
mpd = with_docstring(MpdPlayerSegment(),
('''Return Music Player Daemon information
Requires mpc command to be acessible from $PATH or ``mpd`` Python module.
Requires ``mpd`` Python module (e.g. |python-mpd2|_ or |python-mpd|_ Python
package) or alternatively the ``mpc`` command to be acessible from $PATH.
.. |python-mpd| replace:: ``python-mpd``
.. _python-mpd: https://pypi.python.org/pypi/python-mpd
.. |python-mpd2| replace:: ``python-mpd2``
.. _python-mpd2: https://pypi.python.org/pypi/python-mpd2
{0}
:param str host: