Skip to content

Commit 056e8b2

Browse files
last of the unfinished kwarg descriptions
1 parent dfc2bbf commit 056e8b2

File tree

1 file changed

+18
-10
lines changed

1 file changed

+18
-10
lines changed

src/mplfinance/plotting.py

+18-10
Original file line numberDiff line numberDiff line change
@@ -1196,40 +1196,48 @@ def _valid_addplot_kwargs():
11961196
all([isinstance(v,(int,float)) for v in value]) },
11971197

11981198
'secondary_y' : { 'Default' : 'auto',
1199-
'Description' : '',
1199+
'Description' : "True|False|'auto' place the additional plot data on a"+
1200+
" secondary y-axis. 'auto' compares the magnitude or the"+
1201+
" addplot data, to data already on the axis, and if it appears"+
1202+
" they are of different magnitudes, then it uses a secondary y-axis."+
1203+
" True or False always override 'auto'.",
12001204
'Validator' : lambda value: isinstance(value,bool) or value == 'auto' },
12011205

12021206
'y_on_right' : { 'Default' : None,
1203-
'Description' : '',
1207+
'Description' : 'True|False put y-axis tick labels on the right, for this addplot'+
1208+
' regardless of what the mplfinance style says to to.',
12041209
'Validator' : lambda value: isinstance(value,bool) },
1205-
1210+
12061211
'ylabel' : { 'Default' : None,
1207-
'Description' : '',
1212+
'Description' : 'label for y-axis (for this addplot)',
12081213
'Validator' : lambda value: isinstance(value,str) },
12091214

12101215
'ylim' : {'Default' : None,
1211-
'Description' : '',
1216+
'Description' : 'Limits for addplot y-axis as tuple (min,max), i.e. (bottom,top)',
12121217
'Validator' : lambda value: isinstance(value, (list,tuple)) and len(value) == 2
12131218
and all([isinstance(v,(int,float)) for v in value])},
12141219

12151220
'title' : { 'Default' : None,
1216-
'Description' : '',
1221+
'Description' : 'Axes Title (subplot title) for this addplot.',
12171222
'Validator' : lambda value: isinstance(value,str) },
12181223

12191224
'ax' : { 'Default' : None,
1220-
'Description' : '',
1225+
'Description' : 'Matplotlib Axes object on which to plot this addplot',
12211226
'Validator' : lambda value: isinstance(value,mpl_axes.Axes) },
12221227

12231228
'yscale' : { 'Default' : None,
1224-
'Description' : '',
1229+
'Description' : 'addplot y-axis scale: "linear", "log", "symlog", or "logit"',
12251230
'Validator' : lambda value: _yscale_validator(value) },
12261231

12271232
'stepwhere' : { 'Default' : 'pre',
1228-
'Description' : '',
1233+
'Description' : "'pre','post', or 'mid': where to place step relative"+
1234+
" to data for `type='step'`",
12291235
'Validator' : lambda value : value in valid_stepwheres },
12301236

12311237
'marketcolors': { 'Default' : None, # use 'style' for default, instead.
1232-
'Description' : '',
1238+
'Description' : "marketcolors for this addplot (instead of the mplfinance"+
1239+
" style\'s marketcolors). For addplot `type='ohlc'`"+
1240+
" and type='candle'",
12331241
'Validator' : lambda value: _is_marketcolor_object(value) },
12341242
}
12351243

0 commit comments

Comments
 (0)