mention log and date info on shapes.yref similar to xref

archmoj · archmoj · commit 219bfee75038 · 2022-05-19T16:51:37.000-04:00
diff --git a/src/components/shapes/attributes.js b/src/components/shapes/attributes.js
@@ -109,6 +109,10 @@ module.exports = templatedArray('shape', {
         description: [
             'Sets the annotation\'s y coordinate axis.',
             axisPlaceableObjs.axisRefDescription('y', 'bottom', 'top'),
+            'If the axis `type` is *log*, then you must take the',
+            'log of your desired range.',
+            'If the axis `type` is *date*, then you must convert',
+            'the date to unix time in milliseconds.'
         ].join(' ')
     }),
     ysizemode: {
diff --git a/test/plot-schema.json b/test/plot-schema.json
@@ -7009,7 +7009,7 @@
        "valType": "any"
       },
       "yref": {
-       "description": "Sets the annotation's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y  axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis.",
+       "description": "Sets the annotation's y coordinate axis. If set to a y axis id (e.g. *y* or *y2*), the `y` position refers to a y coordinate. If set to *paper*, the `y` position refers to the distance from the bottom of the plotting area in normalized coordinates where *0* (*1*) corresponds to the bottom (top). If set to a y axis ID followed by *domain* (separated by a space), the position behaves like for *paper*, but refers to the distance in fractions of the domain length from the bottom of the domain of that axis: e.g., *y2 domain* refers to the domain of the second y  axis and a y position of 0.5 refers to the point between the bottom and the top of the domain of the second y axis. If the axis `type` is *log*, then you must take the log of your desired range. If the axis `type` is *date*, then you must convert the date to unix time in milliseconds.",
        "editType": "calc",
        "valType": "enumerated",
        "values": [
