Skip to content

Commit d868194

Browse files
more kwarg descriptions
1 parent c228078 commit d868194

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

src/mplfinance/plotting.py

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -326,19 +326,22 @@ def _valid_plot_kwargs():
326326
'Validator' : lambda value: value in ('v0', 'v1') },
327327

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

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

336339
'return_width_config' : { 'Default' : None,
337-
'Description' : '',
340+
'Description' : 'empty dict variable to be filled with width configuration settings.',
338341
'Validator' : lambda value: isinstance(value,dict) and len(value)==0 },
339342

340343
'saxbelow' : { 'Default' : True, # Issue#115 Comment#639446764
341-
'Description' : '',
344+
'Description' : 'set the volume Axes below (behind) all other Axes objects',
342345
'Validator' : lambda value: isinstance(value,bool) },
343346

344347
'ax' : { 'Default' : None,

0 commit comments

Comments
 (0)