Merge pull request #491 from DanielGoldfarb/master

Ability to sort kwargs alphabetically when calling `kwarg_help()`

Author: DanielGoldfarb

.gitignore

@@ -7,5 +7,4 @@ __pycache__
 .tox/
 .cache/
 *.code-workspace
-examples/.ipynb_checkpoints/
-examples/scratch_pad/.ipynb_checkpoints/
+*.ipynb_checkpoints/

src/mplfinance/_kwarg_help.py

@@ -57,7 +57,7 @@ def left_formatter(value):
     return left_formatter
 
 
-def kwarg_help( func_name=None, kwarg_names=None ):
+def kwarg_help( func_name=None, kwarg_names=None, sort=False ):
 
     func_kwarg_map = {
         'plot'              : mpf.plotting._valid_plot_kwargs,
@@ -113,6 +113,7 @@ def kwarg_help( func_name=None, kwarg_names=None ):
 
     df = (pd.DataFrame(vks).T).drop('Validator',axis=1)
     df.index.name = 'Kwarg'
+    if sort: df.sort_index(inplace=True)
     df.reset_index(inplace=True)
 
     if kwarg_names is not None:

src/mplfinance/_styles.py

@@ -114,6 +114,7 @@ def _valid_make_mpf_style_kwargs():
                             'Validator'   : lambda value: isinstance(value,dict) },
 
         'style_name'    : { 'Default'     : None,
+                            'Description' : '',
                             'Validator'   : lambda value: isinstance(value,str) },
 
     }

src/mplfinance/_version.py

@@ -1,5 +1,5 @@
 
-version_info = (0, 12, 8, 'beta', 7)
+version_info = (0, 12, 8, 'beta', 8)
 
 _specifier_ = {'alpha': 'a','beta': 'b','candidate': 'rc','final': ''}