replaced 'forced_order' with 'sort'

Kully · Kully · commit 1658eeb58e43 · 2017-05-17T15:51:52.000-04:00
diff --git a/plotly/figure_factory/_violin.py b/plotly/figure_factory/_violin.py
@@ -1,4 +1,4 @@
-from __future__ import absolute_import
+sortfrom __future__ import absolute_import
 
 from numbers import Number
 
@@ -194,7 +194,7 @@ def violinplot(vals, fillcolor='#1f77b4', rugplot=True):
 
 
 def violin_no_colorscale(data, data_header, group_header, colors,
-                         use_colorscale, group_stats, rugplot, forced_order,
+                         use_colorscale, group_stats, rugplot, sort,
                          height, width, title):
     """
     Refer to FigureFactory.create_violin() for docstring.
@@ -208,7 +208,7 @@ def violin_no_colorscale(data, data_header, group_header, colors,
     for name in data[group_header]:
         if name not in group_name:
             group_name.append(name)
-    if forced_order:
+    if sort:
         group_name.sort()
 
     gb = data.groupby([group_header])
@@ -251,7 +251,7 @@ def violin_no_colorscale(data, data_header, group_header, colors,
 
 
 def violin_colorscale(data, data_header, group_header, colors, use_colorscale,
-                      group_stats, rugplot, forced_order, height, width,
+                      group_stats, rugplot, sort, height, width,
                       title):
     """
     Refer to FigureFactory.create_violin() for docstring.
@@ -265,7 +265,7 @@ def violin_colorscale(data, data_header, group_header, colors, use_colorscale,
     for name in data[group_header]:
         if name not in group_name:
             group_name.append(name)
-    if forced_order:
+    if sort:
         group_name.sort()
 
     # make sure all group names are keys in group_stats
@@ -347,7 +347,7 @@ def violin_colorscale(data, data_header, group_header, colors, use_colorscale,
 
 
 def violin_dict(data, data_header, group_header, colors, use_colorscale,
-                group_stats, rugplot, forced_order, height, width, title):
+                group_stats, rugplot, sort, height, width, title):
     """
     Refer to FigureFactory.create_violin() for docstring.
 
@@ -361,7 +361,7 @@ def violin_dict(data, data_header, group_header, colors, use_colorscale,
         if name not in group_name:
             group_name.append(name)
 
-    if forced_order:
+    if sort:
         group_name.sort()
 
     # check if all group names appear in colors dict
@@ -409,7 +409,7 @@ def violin_dict(data, data_header, group_header, colors, use_colorscale,
 
 def create_violin(data, data_header=None, group_header=None, colors=None,
                   use_colorscale=False, group_stats=None, rugplot=True,
-                  forced_order=False, height=450, width=600,
+                  sort=False, height=450, width=600,
                   title='Violin and Rug Plot'):
     """
     Returns figure for a violin plot
@@ -440,7 +440,7 @@ def create_violin(data, data_header=None, group_header=None, colors=None,
         number and will be used to color the violin plots if a colorscale
         is being used.
     :param (bool) rugplot: determines if a rugplot is draw on violin plot.
-    :param (bool) forced_order: determines if violins are sorted
+    :param (bool) sort: determines if violins are sorted.
         alphabetically (True) or by inputted order (False).
     :param (float) height: the height of the violin plot.
     :param (float) width: the width of the violin plot.
@@ -489,7 +489,7 @@ def create_violin(data, data_header=None, group_header=None, colors=None,
 
     # create violin fig
     fig = create_violin(df, data_header='Score', group_header='Group',
-                        forced_order=True, height=600, width=1000)
+                        sort=True, height=600, width=1000)
 
     # plot
     py.iplot(fig, filename='Violin Plot with Coloring')
@@ -607,14 +607,14 @@ def create_violin(data, data_header=None, group_header=None, colors=None,
                 # validate colors dict choice below
                 fig = violin_dict(
                     data, data_header, group_header, valid_colors,
-                    use_colorscale, group_stats, rugplot, forced_order,
+                    use_colorscale, group_stats, rugplot, sort,
                     height, width, title
                 )
                 return fig
             else:
                 fig = violin_no_colorscale(
                     data, data_header, group_header, valid_colors,
-                    use_colorscale, group_stats, rugplot, forced_order,
+                    use_colorscale, group_stats, rugplot, sort,
                     height, width, title
                 )
                 return fig
