Skip to content

Commit ef4872d

Browse files
finish up width config documentation
1 parent 835911f commit ef4872d

File tree

3 files changed

+201
-580
lines changed

3 files changed

+201
-580
lines changed

examples/widths.ipynb

Lines changed: 198 additions & 577 deletions
Large diffs are not rendered by default.

src/mplfinance/_widths.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -101,9 +101,9 @@ def _determine_width_config( xdates, config ):
101101
width_config['candle_width' ] = _dfinterpolate(_widths,datalen,'cw' ) * adjust
102102
width_config['candle_linewidth'] = _dfinterpolate(_widths,datalen,'clw')
103103

104-
if config['scale_width_config'] is not None:
104+
if config['scale_width_adjustment'] is not None:
105105

106-
scale = _process_kwargs(config['scale_width_config'],_valid_scale_width_kwargs())
106+
scale = _process_kwargs(config['scale_width_adjustment'],_valid_scale_width_kwargs())
107107
if scale['volume'] is not None:
108108
width_config['volume_width'] *= scale['volume']
109109
if scale['ohlc'] is not None:

src/mplfinance/plotting.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -218,7 +218,7 @@ def _valid_plot_kwargs():
218218
'width_adjuster_version' : { 'Default' : 'v1',
219219
'Validator' : lambda value: value in ('v0', 'v1') },
220220

221-
'scale_width_config' : { 'Default' : None,
221+
'scale_width_adjustment' : { 'Default' : None,
222222
'Validator' : lambda value: isinstance(value,dict) and len(value) > 0 },
223223

224224
'update_width_config' : { 'Default' : None,

0 commit comments

Comments
 (0)