forgot to update docstrings in #117

xarray-contrib · Apr 1, 2020 · 2a0a235 · 2a0a235
1 parent e78ed54
commit 2a0a235
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 11 deletions.
diff --git a/xsimlab/variable.py b/xsimlab/variable.py
@@ -176,9 +176,9 @@ def variable(
     encoding : dict, optional
         Dictionary specifying how to encode this variable's data into a
         serialized format (i.e., as a zarr dataset). Currently used keys
-        include 'chunks', 'dtype', 'compressor', 'fill_value', 'order',
-        'filters' and 'object_codec'. See :func:`zarr.creation.create` for
-        details about these options. Other keys are ignored.
+        include 'dtype', 'compressor', 'fill_value', 'order', 'filters'
+        and 'object_codec'. See :func:`zarr.creation.create` for details
+        about these options. Other keys are ignored.
 
     See Also
     --------
@@ -244,9 +244,9 @@ def index(dims, groups=None, description="", attrs=None, encoding=None):
     encoding : dict, optional
         Dictionary specifying how to encode this variable's data into a
         serialized format (i.e., as a zarr dataset). Currently used keys
-        include 'chunks', 'dtype', 'compressor', 'fill_value', 'order',
-        'filters' and 'object_codec'. See :func:`zarr.creation.create` for
-        details about these options. Other keys are ignored.
+        include 'dtype', 'compressor', 'fill_value', 'order', 'filters'
+        and 'object_codec'. See :func:`zarr.creation.create` for details
+        about these options. Other keys are ignored.
 
     See Also
     --------
@@ -313,9 +313,9 @@ def on_demand(
     encoding : dict, optional
         Dictionary specifying how to encode this variable's data into a
         serialized format (i.e., as a zarr dataset). Currently used keys
-        include 'chunks', 'dtype', 'compressor', 'fill_value', 'order',
-        'filters' and 'object_codec'. See :func:`zarr.creation.create` for
-        details about these options. Other keys are ignored.
+        include 'dtype', 'compressor', 'fill_value', 'order', 'filters'
+        and 'object_codec'. See :func:`zarr.creation.create` for details
+        about these options. Other keys are ignored.
 
     See Also
     --------

diff --git a/xsimlab/xr_accessor.py b/xsimlab/xr_accessor.py
@@ -699,9 +699,10 @@ def run(
             Nested dictionary with variable names as keys and dictionaries of
             variable specific encodings as values, e.g.,
             ``{'my_variable': {'dtype': 'int16', 'fill_value': -9999,}, ...}``.
-            See the ``encoding`` parameter of :func:`~xsimlab.variable`.
             Encoding options provided here override encoding options defined in
-            model variables.
+            model variables (see :func:`~xsimlab.variable` for a full list of
+            of options available). Additionally, 'chunks' and 'synchronizer'
+            options are supported here.
         hooks : list, optional
             One or more runtime hooks, i.e., functions decorated with
             :func:`~xsimlab.runtime_hook` or instances of