@@ -1196,40 +1196,48 @@ def _valid_addplot_kwargs():
1196
1196
all ([isinstance (v ,(int ,float )) for v in value ]) },
1197
1197
1198
1198
'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'." ,
1200
1204
'Validator' : lambda value : isinstance (value ,bool ) or value == 'auto' },
1201
1205
1202
1206
'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.' ,
1204
1209
'Validator' : lambda value : isinstance (value ,bool ) },
1205
-
1210
+
1206
1211
'ylabel' : { 'Default' : None ,
1207
- 'Description' : '' ,
1212
+ 'Description' : 'label for y-axis (for this addplot) ' ,
1208
1213
'Validator' : lambda value : isinstance (value ,str ) },
1209
1214
1210
1215
'ylim' : {'Default' : None ,
1211
- 'Description' : '' ,
1216
+ 'Description' : 'Limits for addplot y-axis as tuple (min,max), i.e. (bottom,top) ' ,
1212
1217
'Validator' : lambda value : isinstance (value , (list ,tuple )) and len (value ) == 2
1213
1218
and all ([isinstance (v ,(int ,float )) for v in value ])},
1214
1219
1215
1220
'title' : { 'Default' : None ,
1216
- 'Description' : '' ,
1221
+ 'Description' : 'Axes Title (subplot title) for this addplot. ' ,
1217
1222
'Validator' : lambda value : isinstance (value ,str ) },
1218
1223
1219
1224
'ax' : { 'Default' : None ,
1220
- 'Description' : '' ,
1225
+ 'Description' : 'Matplotlib Axes object on which to plot this addplot ' ,
1221
1226
'Validator' : lambda value : isinstance (value ,mpl_axes .Axes ) },
1222
1227
1223
1228
'yscale' : { 'Default' : None ,
1224
- 'Description' : '' ,
1229
+ 'Description' : 'addplot y-axis scale: "linear", "log", "symlog", or "logit" ' ,
1225
1230
'Validator' : lambda value : _yscale_validator (value ) },
1226
1231
1227
1232
'stepwhere' : { 'Default' : 'pre' ,
1228
- 'Description' : '' ,
1233
+ 'Description' : "'pre','post', or 'mid': where to place step relative" +
1234
+ " to data for `type='step'`" ,
1229
1235
'Validator' : lambda value : value in valid_stepwheres },
1230
1236
1231
1237
'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'" ,
1233
1241
'Validator' : lambda value : _is_marketcolor_object (value ) },
1234
1242
}
1235
1243
0 commit comments