Add more docstrings

[python-musicpdaio.git] / doc / source / explanations.rst

diff --git a/doc/source/explanations.rst b/doc/source/explanations.rst
index b3d4fbbc78d183c94083842c084c9d07efbaa605..86c45ce2622e0b41ff7d70548cc4587f6c9eea22 100644 (file)
--- a/doc/source/explanations.rst
+++ b/doc/source/explanations.rst
@@ -40,7 +40,7 @@ The MPD command protocol exchanges line-based text records. The client emits a
 command with optional arguments. In the example above the client sends a
 `setvol` command with the string argument `42`.
 
-MPD commands are exposed as :py:class:`mpdaio.MPDClient` methods. Methods
+MPD commands are exposed as |mpdaio.MPDClient| methods. Methods
 **arguments are python strings**. Some commands are composed of more than one word
 (ie "**tagtypes [disable|enable|all]**"), for these use a `snake case`_ style to
 access the method. Then **"tagtypes enable"** command is called with
@@ -52,11 +52,11 @@ strings. In the example above, an integer can be used as argument for the
 written to the socket. To avoid confusion use regular string instead of relying
 on object string representation.
 
-:py:class:`mpdaio.MPDClient` methods returns different kinds of objects
+|mpdaio.MPDClient| methods returns different kinds of objects
 depending on the command. Could be :py:obj:`None`, a single object as a
 :py:obj:`str` or a :py:obj:`dict`, a list of :py:obj:`dict`.
 
-Then :py:class:`mpdaio.MPDClient` **methods signatures** are not hard coded
+Then |mpdaio.MPDClient| **methods signatures** are not hard coded
 within this module since the protocol is handled on the server side. Please
 refer to the protocol and MPD commands in `MPD protocol documentation`_ to
 learn how to call commands and what kind of arguments they expect.
@@ -64,7 +64,7 @@ learn how to call commands and what kind of arguments they expect.
 Some examples are provided for the most common cases, see :ref:`tutorial`.
 
 **musicpdaio** tries to come with sane defaults, then running
-:py:class:`mpdaio.MPDClient` with no explicit argument will try default values
+|mpdaio.MPDClient| with no explicit argument will try default values
 to connect to MPD. Cf. :ref:`reference` for more about
 :ref:`defaults<default_settings>`.
 
@@ -77,7 +77,7 @@ Socket connection
 **musicpdaio** uses a connection pool internally to keep already opened socket
 and reuse it.
 
-When first instantiated :py:class:`mpdaio.MPDClient` comes with an empty pool,
+When first instantiated |mpdaio.MPDClient| comes with an empty pool,
 when the first MPD command is called a connection is opened, saved and
 potentially reused later. In case a concurrent MPD command is called while the
 connection is still in use a new connection is made and kept in the pool.