Merge pull request #49 from manics/example-version

Include version in examples

src/omero_cli_render.py

@@ -83,9 +83,12 @@
     omero render set Image:1 settings.json
     omero render set Dataset:1 settings.yml
 
-    # where the input file (YAML or JSON) contains a top-level channels
-    # key (required), and an optional top-level greyscale key (True: greyscale,
-    # False: color). Channel elements are index:dictionaries of the form:
+    # where the input file (YAML or JSON) contains:
+    # - a top-level channels key (required)
+    # - a version (recommended, current version: 2)
+    # - an optional top-level greyscale key (True: greyscale,
+    # False: color).
+    # Channel elements are index:dictionaries of the form:
 
     channels:               Required
       <int>:                Channel index, 1-based
@@ -99,6 +102,7 @@
     greyscale: <bool>               Greyscale rendering, optional
     z: <int>                        Default Z plane index, 1-based, optional
     t: <int>                        Default T plane index, 1-based, optional
+    version: 2                      Version of the renderdef specification
 
     For example:
 
@@ -114,6 +118,7 @@
       ...
     z: 5
     t: 1
+    version: 2
 
     # Omitted fields will keep their current values.
     # Omitted channels will not be disabled unless --disable is used.