From: Kaliko Jack <kaliko@azylum.org>
Date: Thu, 8 Oct 2020 06:53:43 +0000 (+0200)
Subject: Documentation more explicit (closes #6)
X-Git-Tag: v0.5.0~9
X-Git-Url: https://git.kaliko.me/?p=python-musicpd.git;a=commitdiff_plain;h=5339d4669b467ce8760d11bf6ba6c9579fb7ebea

Documentation more explicit (closes #6)
---

diff --git a/doc/source/use.rst b/doc/source/use.rst
index d8e46e7..18fdd29 100644
--- a/doc/source/use.rst
+++ b/doc/source/use.rst
@@ -11,10 +11,12 @@ The client library can be used as follows:
                                        #   fallback to localhost:6600
                                        # connect support host/port argument as well
     print(client.mpd_version)          # print the mpd protocol version
-    print(client.cmd('one', 2))        # print result of the command "cmd one 2"
+    print(client.cmd('foo', 42))       # print result of the request "cmd foo 42"
+                                       # (nb. for actual command, see link to the protocol below)
     client.disconnect()                # disconnect from the server
 
-For a list of supported commands, their arguments (as MPD currently understands
+In the example above `cmd` in not an actual MPD command, for a list of
+supported commands, their arguments (as MPD currently understands
 them), and the functions used to parse their responses see :ref:`commands`.
 
 See the `MPD protocol documentation`_ for more details.