Fix documentation

Author: kdorr

mplaltair/_axis.py

@@ -9,9 +9,10 @@ def _set_limits(channel, scale):
 
     Parameters
     ----------
+    channel : dict
+        The mapping of the channel data and metadata
     scale : dict
         The mapping of the scale metadata and the scale data
-
     """
 
     _axis_kwargs = {
@@ -61,8 +62,20 @@ def _set_limits(channel, scale):
 
 def _set_scale_type(channel, scale):
     """If the scale is non-linear, change the scale and return appropriate axis limits.
-    Note: The 'linear' and 'time' scale types are not included here because quantitative defaults to 'linear'
-    and temporal defaults to 'time'. The 'utc' and 'sequential' are currently not supported.
+    The 'linear' and 'time' scale types are not included here because quantitative defaults to 'linear'
+    and temporal defaults to 'time'. The 'utc' and 'sequential' scales are currently not supported.
+
+    Parameters
+    ----------
+    channel : dict
+        The mapping of the channel data and metadata
+    scale : dict
+        The mapping of the scale metadata and the scale data
+
+    Returns
+    -------
+    lims : dict
+        The axis limit mapped to the appropriate axis parameter for scales that change axis limit behavior
     """
     lims = {}
     if scale['type'] == 'log':
@@ -107,9 +120,15 @@ def _set_scale_type(channel, scale):
 
 
 def _set_tick_locator(channel, axis):
-    """Set the tick locator if it needs to vary from the default"""
-    # Works for quantitative and temporal
-    # The auto locator has similar (if not the same) defaults as Altair
+    """Set the tick locator if it needs to vary from the default locator
+
+    Parameters
+    ----------
+    channel : dict
+        The mapping of the channel data and metadata
+    axis : dict
+        The mapping of the axis metadata and the scale data
+    """
     current_axis = {'x': channel['ax'].xaxis, 'y': channel['ax'].yaxis}
     if 'values' in axis:
         if channel['dtype'] == 'temporal':
@@ -125,6 +144,15 @@ def _set_tick_locator(channel, axis):
 
 
 def _set_tick_formatter(channel, axis):
+    """Set the tick formatter
+
+    Parameters
+    ----------
+    channel : dict
+        The mapping of the channel data and metadata
+    axis : dict
+        The mapping of the axis metadata and the scale data
+    """
     current_axis = {'x': channel['ax'].xaxis, 'y': channel['ax'].yaxis}
     format_str = ''
 

mplaltair/_data.py

@@ -69,8 +69,7 @@ def _handle_timeUnit():
 
 
 def _locate_channel_scale(chart, channel):
-    """Locates the channel's scale information. Note that this implementation is a little
-    different (and a little cleaner) than the other locate functions in this module.
+    """Locates the channel's scale information.
 
     Parameters
     ----------
@@ -91,8 +90,7 @@ def _locate_channel_scale(chart, channel):
 
 
 def _locate_channel_axis(chart, channel):
-    """Locates the channel's scale information. Note that this implementation is a little
-    different (and a little cleaner) than the other locate functions in this module.
+    """Locates the channel's scale information.
 
     Parameters
     ----------
@@ -116,13 +114,13 @@ def _convert_to_mpl_date(data):
 
     Parameters
     ----------
-    data
-        The data to be converted to a Matplotlib date.
+    data : datetime.datetime, numpy.datetime64, str, Altair DateTime, or sequences of any of these
+        The data to be converted to a Matplotlib date
 
     Returns
     -------
     new_data : list
-        A list containing the converted date(s).
+        A list containing the converted date(s)
     """
 
     if cbook.iterable(data) and not isinstance(data, str) and not isinstance(data, dict):
@@ -143,7 +141,8 @@ def _convert_to_mpl_date(data):
 
 
 def _altair_DateTime_to_datetime(dt):
-    """Convert dictionary representation of an Altair DateTime to datetime object.
+    """Convert dictionary representation of an Altair DateTime to datetime object
+
     Parameters
     ----------
     dt : dict

mplaltair/tests/test_axis.py

@@ -6,8 +6,6 @@
 from .._axis import convert_axis
 import pytest
 
-# from .._data import _locate_channel_dtype
-
 df_quant = pd.DataFrame({
     "a": [1, 2, 3], "b": [1.2, 2.4, 3.8], "c": [7, 5, -3],
     "s": [50, 100, 200.0], "alpha": [0, .5, .8], "shape": [1, 2, 3], "fill": [1, 2, 3],
@@ -24,14 +22,6 @@
     "combination": pd.to_datetime(['1/1/2015 00:00', '1/4/2016 10:00', '5/1/2016', '5/1/2016 10:10', '3/3/2016'])
 })
 
-# def test_axis_dtype():
-#     chart = alt.Chart(df_quant).mark_point().encode(alt.X('years'), alt.Y('a'))
-#     mapping = convert(chart)
-#     fig, ax = plt.subplots()
-#     ax.scatter(**mapping)
-#     convert_axis(ax, chart)
-#     assert _locate_channel_dtype(chart, 'x') == 'temporal'
-
 
 @pytest.mark.xfail(raises=TypeError)
 def test_invalid_temporal():
@@ -190,7 +180,7 @@ def test_axis_scale_type_x_quantitative(column, type, base, exponent):
 
 
 @pytest.mark.mpl_image_compare(baseline_dir='baseline_images/test_axis')
-@pytest.mark.parametrize('column,type,base,exponent', [('log','log',10,1), ('log2','log',5,1)])
+@pytest.mark.parametrize('column,type,base,exponent', [('log', 'log', 10, 1), ('log2', 'log', 5, 1)])
 def test_axis_scale_type_y_quantitative(column, type, base, exponent):
     chart = alt.Chart(df_quant).mark_point().encode(
         alt.X('a'),