From 5339d4669b467ce8760d11bf6ba6c9579fb7ebea Mon Sep 17 00:00:00 2001 From: Kaliko Jack Date: Thu, 8 Oct 2020 08:53:43 +0200 Subject: [PATCH] Documentation more explicit (closes #6) --- doc/source/use.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) 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. -- 2.39.2