Skip to content

Commit dfc2bbf

Browse files
DanielGoldfarbDanielGoldfarb
committed
yet more kwarg descriptions
1 parent d868194 commit dfc2bbf

File tree

1 file changed

+19
-18
lines changed

1 file changed

+19
-18
lines changed

‎src/mplfinance/plotting.py

+19-18
Original file line numberDiff line numberDiff line change
@@ -327,12 +327,12 @@ def _valid_plot_kwargs():
327327

328328
'scale_width_adjustment' : { 'Default' : None,
329329
'Description' : 'scale width of plot objects wider, > 1.0, or narrower, < 1.0'+
330-
' may also be a dict to scale individual widths.'+,
330+
' may also be a dict to scale individual widths.'+
331331
' (See also "widths" tutorial in mplfinance examples folder).',
332332
'Validator' : lambda value: isinstance(value,dict) and len(value) > 0 },
333333

334334
'update_width_config' : { 'Default' : None,
335-
'Description' : 'dict - update individual items in width configuration.'+,
335+
'Description' : 'dict - update individual items in width configuration.'+
336336
' (See also "widths" tutorial in mplfinance examples folder).',
337337
'Validator' : lambda value: isinstance(value,dict) and len(value) > 0 },
338338

@@ -349,24 +349,25 @@ def _valid_plot_kwargs():
349349
'Validator' : lambda value: isinstance(value,mpl_axes.Axes) },
350350

351351
'volume_exponent' : { 'Default' : None,
352-
'Description' : '',
352+
'Description' : 'integer exponent on the volume axis'+
353+
' (or set to "legacy" for old mplfinance style)',
353354
'Validator' : lambda value: isinstance(value,int) or value == 'legacy'},
354355

355356
'tz_localize' : { 'Default' : True,
356-
'Description' : '',
357+
'Description' : 'True|False localize the times in the DatetimeIndex',
357358
'Validator' : lambda value: isinstance(value,bool) },
358359

359360
'yscale' : { 'Default' : None,
360-
'Description' : '',
361+
'Description' : 'y-axis scale: "linear", "log", "symlog", or "logit"',
361362
'Validator' : lambda value: _yscale_validator(value) },
362363

363364
'volume_yscale' : { 'Default' : None,
364-
'Description' : '',
365+
'Description' : 'Volume y-axis scale: "linear", "log", "symlog", or "logit"',
365366
'Validator' : lambda value: _yscale_validator(value) },
366367

367368
'warn_too_much_data' : { 'Default' : 599,
368-
'Description' : ('Tolerance for data amount in plot. Default=599 rows.'+
369-
' Values greater than \'warn_too_much_data\' will trigger a warning.'),
369+
'Description' : 'Tolerance for data amount in plot. Default=599 rows.'+
370+
' Values greater than \'warn_too_much_data\' will trigger a warning.',
370371
'Validator' : lambda value: isinstance(value,int) },
371372
}
372373

@@ -1140,31 +1141,31 @@ def _valid_addplot_kwargs():
11401141

11411142
vkwargs = {
11421143
'scatter' : { 'Default' : False,
1143-
'Description' : '',
1144+
'Description' : "Deprecated. (Use kwarg `type='scatter' instead.",
11441145
'Validator' : lambda value: isinstance(value,bool) },
11451146

11461147
'type' : { 'Default' : 'line',
1147-
'Description' : '',
1148+
'Description' : 'addplot type: "line","scatter","bar", "ohlc", "candle","step"',
11481149
'Validator' : lambda value: value in valid_types },
11491150

11501151
'mav' : { 'Default' : None,
1151-
'Description' : '',
1152+
'Description' : 'Moving Average window size(s); (int or tuple of ints)',
11521153
'Validator' : _mav_validator },
11531154

11541155
'panel' : { 'Default' : 0,
1155-
'Description' : '',
1156+
'Description' : 'Panel (int 0-31) to use for this addplot',
11561157
'Validator' : lambda value: _valid_panel_id(value) },
11571158

11581159
'marker' : { 'Default' : 'o',
1159-
'Description' : '',
1160+
'Description' : "marker for `type='scatter'` plot",
11601161
'Validator' : lambda value: _bypass_kwarg_validation(value) },
11611162

11621163
'markersize' : { 'Default' : 18,
1163-
'Description' : 'size of marker for `type=scatter`; default=18',
1164+
'Description' : 'size of marker for `type="scatter"`; default=18',
11641165
'Validator' : lambda value: isinstance(value,(int,float)) },
11651166

11661167
'color' : { 'Default' : None,
1167-
'Description' : 'color of line, scatter marker, or bar',
1168+
'Description' : 'color (or sequence of colors) of line(s), scatter marker(s), or bar(s).',
11681169
'Validator' : lambda value: mcolors.is_color_like(value) or
11691170
(isinstance(value,(list,tuple,np.ndarray)) and all([mcolors.is_color_like(v) for v in value])) },
11701171

@@ -1173,15 +1174,15 @@ def _valid_addplot_kwargs():
11731174
'Validator' : lambda value: value in valid_linestyles },
11741175

11751176
'linewidths' : { 'Default': None,
1176-
'Description' : '',
1177+
'Description' : 'edge widths of scatter markers',
11771178
'Validator' : lambda value: isinstance(value,(int,float)) },
11781179

11791180
'edgecolors' : { 'Default': None,
1180-
'Description' : '',
1181+
'Description' : 'edgecolors of scatter markers',
11811182
'Validator': lambda value: mcolors.is_color_like(value) or value in valid_edgecolors},
11821183

11831184
'width' : { 'Default' : None, # width of `bar` or `line`
1184-
'Description' : '',
1185+
'Description' : 'width of bar or line for `type="bar"` or `type="line"',
11851186
'Validator' : lambda value: isinstance(value,(int,float)) or
11861187
all([isinstance(v,(int,float)) for v in value]) },
11871188

0 commit comments

Comments
 (0)