X-Git-Url: https://git.kaliko.me/?p=python-musicpd.git;a=blobdiff_plain;f=README.rst;h=61b305fec96b4ec1277c1bdd06ce4b266e5a0390;hp=2bd88dce0ac714c31bee7c2fbfd5befcbaec3732;hb=86a40a9a5a668399c6ca07022b3c38251686ed1d;hpb=3f041f016053b04b6d6800186a27a7c0700e475c

diff --git a/README.rst b/README.rst
index 2bd88dc..61b305f 100644
--- a/README.rst
+++ b/README.rst
@@ -54,6 +54,25 @@ Command lists are also supported using `command_list_ok_begin()` and
     client.status()                      # insert the status command into the list
     results = client.command_list_end()  # results will be a list with the results
 
+Provide a 2-tuple as argument for command supporting ranges (cf. `MPD protocol documentation`_ for more details).
+Possible ranges are: "START:END", "START:" and ":" ::
+
+    # An intelligent clear
+    # clears played track in the queue, currentsong included
+    pos = client.currentsong().get('pos', 0)
+    # the 2-tuple range object accepts str, no need to convert to int
+    client.delete((0, pos))
+    # missing end interpreted as highest value possible, pay attention still need a tuple.
+    client.delete((pos,))  # purge queue from current to the end
+
+A notable case is the `rangeid` command allowing an empty range specified
+as a single colon as argument (i.e. sending just ":")::
+
+    # sending "rangeid :" to clear the range, play everything
+    client.rangeid(())  # send an empty tuple
+
+Empty start in range (i.e. ":END") are not possible and will raise a CommandError.
+
 
 Commands may also return iterators instead of lists if `iterate` is set to
 `True`::