@@ -61,60 +61,61 @@ def _apply_mpfstyle(style):
6161def _valid_make_mpf_style_kwargs ():
6262 vkwargs = {
6363 'base_mpf_style' : { 'Default' : None ,
64- 'Description' : '' ,
64+ 'Description' : 'mplfinance style to use as base of new mplfinance style ' ,
6565 'Validator' : lambda value : value in _styles .keys () },
6666
6767 'base_mpl_style' : { 'Default' : None ,
68- 'Description' : '' ,
68+ 'Description' : 'matplotlib style to use as base of new mplfinance style ' ,
6969 'Validator' : lambda value : isinstance (value ,str ) }, # and is in plt.style.available
7070
7171 'marketcolors' : { 'Default' : None ,
72- 'Description' : '' ,
72+ 'Description' : 'market colors object, from `mpf.make_market_colors()` ' ,
7373 'Validator' : lambda value : isinstance (value ,dict ) },
7474
7575 'mavcolors' : { 'Default' : None ,
76- 'Description' : '' ,
76+ 'Description' : 'sequence of colors to use for moving averages ' ,
7777 'Validator' : lambda value : isinstance (value ,list ) }, # TODO: all([_mpf_is_color_like(v) for v in value.values()])
7878
7979
8080 'facecolor' : { 'Default' : None ,
81- 'Description' : '' ,
81+ 'Description' : 'background color for Axes ' ,
8282 'Validator' : lambda value : isinstance (value ,str ) },
8383
8484 'edgecolor' : { 'Default' : None ,
85- 'Description' : '' ,
85+ 'Description' : 'edge color for Axes ' ,
8686 'Validator' : lambda value : isinstance (value ,str ) },
8787
8888 'figcolor' : { 'Default' : None ,
89- 'Description' : '' ,
89+ 'Description' : 'background color for Figure. ' ,
9090 'Validator' : lambda value : isinstance (value ,str ) },
9191
9292 'gridcolor' : { 'Default' : None ,
93- 'Description' : '' ,
93+ 'Description' : 'color for grid lines ' ,
9494 'Validator' : lambda value : isinstance (value ,str ) },
9595
9696 'gridstyle' : { 'Default' : None ,
97- 'Description' : '' ,
97+ 'Description' : "grid line style ('-', '--', '-.', ':', '', offset, on-off-seq)." +
98+ " (see also: https://matplotlib.org/stable/gallery/lines_bars_and_markers/linestyles.html)" ,
9899 'Validator' : lambda value : isinstance (value ,str ) },
99100
100101 'gridaxis' : { 'Default' : None ,
101- 'Description' : '' ,
102+ 'Description' : "grid lines 'vertical', 'horizontal', or 'both'" ,
102103 'Validator' : lambda value : value in [ 'vertical' [0 :len (value )], 'horizontal' [0 :len (value )], 'both' [0 :len (value )] ] },
103104
104105 'y_on_right' : { 'Default' : None ,
105- 'Description' : '' ,
106+ 'Description' : 'True|False primary Axes y-ticks and labels on right. ' ,
106107 'Validator' : lambda value : isinstance (value ,bool ) },
107108
108109 'rc' : { 'Default' : None ,
109- 'Description' : '' ,
110+ 'Description' : 'rcparams overrides (dict) (all other rcparams unchanged) ' ,
110111 'Validator' : lambda value : isinstance (value ,dict ) },
111112
112113 'legacy_rc' : { 'Default' : None , # Just in case someone depended upon old behavior
113- 'Description' : '' ,
114+ 'Description' : 'rcparams to set (dict) (all other rcparams cleared) ' ,
114115 'Validator' : lambda value : isinstance (value ,dict ) },
115116
116117 'style_name' : { 'Default' : None ,
117- 'Description' : '' ,
118+ 'Description' : 'name for this style; useful when calling `mpf.write_style_file(style,filename)` ' ,
118119 'Validator' : lambda value : isinstance (value ,str ) },
119120
120121 }
0 commit comments