Skip to content

Commit 2224c85

Browse files
add kwarg descriptions for make_marketcolors
1 parent f1967f6 commit 2224c85

File tree

1 file changed

+16
-11
lines changed

1 file changed

+16
-11
lines changed

src/mplfinance/_styles.py

Lines changed: 16 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -210,55 +210,60 @@ def _valid_mpf_style(value):
210210
def _valid_make_marketcolors_kwargs():
211211
vkwargs = {
212212
'up' : { 'Default' : None,
213-
'Description' : '',
213+
'Description' : 'color to indicate up',
214214
'Validator' : lambda value: _mpf_is_color_like(value) },
215215

216216
'down' : { 'Default' : None,
217-
'Description' : '',
217+
'Description' : 'color to indicate down',
218218
'Validator' : lambda value: _mpf_is_color_like(value) },
219219

220220
'hollow' : { 'Default' : None,
221-
'Description' : '',
221+
'Description' : "color for hollow candles (for `type=hollow`)",
222222
'Validator' : lambda value: _mpf_is_color_like(value) },
223223

224224
'alpha' : { 'Default' : None,
225-
'Description' : '',
225+
'Description' : 'opacity 0.0 (transparent) to 1.0 (opaque);'+
226+
' applies to candles,renko,pnf (but not ohlc bars)',
226227
'Validator' : lambda value: (isinstance(value,float)
227228
and 0.0 <= value and 1.0 >= value ) },
228229

229230
'edge' : { 'Default' : None,
230-
'Description' : '',
231+
'Description' : 'color of candle edge; may also be "i" or "inherit"'+
232+
' to take color from base_mpf_style',
231233
'Validator' : lambda value: _valid_mpf_color_spec(value) },
232234

233235
'wick' : { 'Default' : None,
234-
'Description' : '',
236+
'Description' : "color of candle wick; may be single color,"+
237+
" or may be dict with keys 'up' and 'down'",
235238
'Validator' : lambda value: isinstance(value,dict)
236239
or isinstance(value,str)
237240
or _mpf_is_color_like(value) },
238241

239242
'ohlc' : { 'Default' : None,
240-
'Description' : '',
243+
'Description' : "color of ohlc bars; may be single color,"+
244+
" or may be dict with keys 'up' and 'down'",
241245
'Validator' : lambda value: isinstance(value,dict)
242246
or isinstance(value,str)
243247
or _mpf_is_color_like(value) },
244248

245249
'volume' : { 'Default' : None,
246-
'Description' : '',
250+
'Description' : "color of volume bars; may be single color,"+
251+
" or may be dict with keys 'up' and 'down'",
247252
'Validator' : lambda value: isinstance(value,dict)
248253
or isinstance(value,str)
249254
or _mpf_is_color_like(value) },
250255

251256
'vcdopcod' : { 'Default' : False,
252-
'Description' : '',
257+
'Description' : 'True/False volume color depends on price change from previous day',
253258
'Validator' : lambda value: isinstance(value,bool) },
254259

255260

256261
'inherit' : { 'Default' : False,
257-
'Description' : '',
262+
'Description' : 'inherit color from base_mpf_style for: edge,volume,ohlc,wick',
258263
'Validator' : lambda value: isinstance(value,bool) },
259264

260265
'base_mpf_style': { 'Default' : None,
261-
'Description' : '',
266+
'Description' : 'mplfinance style market colors as basis for new market colors object',
262267
'Validator' : lambda value: isinstance(value,str) },
263268
}
264269

0 commit comments

Comments
 (0)