add ability to sort kwargs in kwarg_help()

matplotlib · Jan 12, 2022 · 882bd91 · 882bd91
1 parent 211431a
commit 882bd91
Showing 1 changed file with 2 additions and 1 deletion.
diff --git a/src/mplfinance/_kwarg_help.py b/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: