Add more detail to attribute descriptions

Author: alexshoe

src/components/shapes/attributes.js

@@ -120,8 +120,9 @@ module.exports = templatedArray('shape', {
         description: [
             "Sets the shape's x coordinate axis.",
             axisPlaceableObjs.axisRefDescription('x', 'left', 'right'),
-            'If an array of axis IDs is provided, each `x` value will refer to the corresponding axis',
-            '(e.g., [\'x\', \'x2\'] for a rectangle means `x0` uses the `x` axis and `x1` uses the `x2` axis).',
+            'If an array of axis IDs is provided, each `x` value will refer to the corresponding axis,',
+            'e.g., [\'x\', \'x2\'] for a rectangle, line, or circle means `x0` uses the `x` axis and `x1` uses the `x2` axis.',
+            'Path shapes using an array should have one entry for each x coordinate in the string.',
         ].join(' ')
     }),
     xsizemode: {
@@ -138,7 +139,8 @@ module.exports = templatedArray('shape', {
             'of data or plot fraction but `x0`, `x1` and x coordinates within `path`',
             'are pixels relative to `xanchor`. This way, the shape can have',
             'a fixed width while maintaining a position relative to data or',
-            'plot fraction.'
+            'plot fraction.',
+            'Note: *pixel* mode is not supported when `xref` is an array.'
         ].join(' ')
     },
     xanchor: {
@@ -191,8 +193,9 @@ module.exports = templatedArray('shape', {
         description: [
             "Sets the shape's y coordinate axis.",
             axisPlaceableObjs.axisRefDescription('y', 'bottom', 'top'),
-            'If an array of axis IDs is provided, each `y` value will refer to the corresponding axis',
-            '(e.g., [\'y\', \'y2\'] for a rectangle means `y0` uses the `y` axis and `y1` uses the `y2` axis).',
+            'If an array of axis IDs is provided, each `y` value will refer to the corresponding axis,',
+            'e.g., [\'y\', \'y2\'] for a rectangle, line, or circle means `y0` uses the `y` axis and `y1` uses the `y2` axis.',
+            'Path shapes using an array should have one entry for each y coordinate in the string.',
         ].join(' ')
     }),
     ysizemode: {
@@ -209,7 +212,8 @@ module.exports = templatedArray('shape', {
             'of data or plot fraction but `y0`, `y1` and y coordinates within `path`',
             'are pixels relative to `yanchor`. This way, the shape can have',
             'a fixed height while maintaining a position relative to data or',
-            'plot fraction.'
+            'plot fraction.',
+            'Note: *pixel* mode is not supported when `yref` is an array.'
         ].join(' ')
     },
     yanchor: {

test/plot-schema.json

@@ -9899,7 +9899,7 @@
             },
             "xref": {
               "arrayOk": true,
-              "description": "Sets the shape's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x 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 left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x  axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. If an array of axis IDs is provided, each `x` value will refer to the corresponding axis (e.g., ['x', 'x2'] for a rectangle means `x0` uses the `x` axis and `x1` uses the `x2` axis).",
+              "description": "Sets the shape's x coordinate axis. If set to a x axis id (e.g. *x* or *x2*), the `x` position refers to a x coordinate. If set to *paper*, the `x` position refers to the distance from the left of the plotting area in normalized coordinates where *0* (*1*) corresponds to the left (right). If set to a x 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 left of the domain of that axis: e.g., *x2 domain* refers to the domain of the second x  axis and a x position of 0.5 refers to the point between the left and the right of the domain of the second x axis. If an array of axis IDs is provided, each `x` value will refer to the corresponding axis, e.g., ['x', 'x2'] for a rectangle, line, or circle means `x0` uses the `x` axis and `x1` uses the `x2` axis. Path shapes using an array should have one entry for each x coordinate in the string.",
               "editType": "calc",
               "valType": "enumerated",
               "values": [
@@ -9913,7 +9913,7 @@
               "valType": "string"
             },
             "xsizemode": {
-              "description": "Sets the shapes's sizing mode along the x axis. If set to *scaled*, `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to *paper*). If set to *pixel*, `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction.",
+              "description": "Sets the shapes's sizing mode along the x axis. If set to *scaled*, `x0`, `x1` and x coordinates within `path` refer to data values on the x axis or a fraction of the plot area's width (`xref` set to *paper*). If set to *pixel*, `xanchor` specifies the x position in terms of data or plot fraction but `x0`, `x1` and x coordinates within `path` are pixels relative to `xanchor`. This way, the shape can have a fixed width while maintaining a position relative to data or plot fraction. Note: *pixel* mode is not supported when `xref` is an array.",
               "dflt": "scaled",
               "editType": "calc+arraydraw",
               "valType": "enumerated",
@@ -9955,7 +9955,7 @@
             },
             "yref": {
               "arrayOk": true,
-              "description": "Sets the shape'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 an array of axis IDs is provided, each `y` value will refer to the corresponding axis (e.g., ['y', 'y2'] for a rectangle means `y0` uses the `y` axis and `y1` uses the `y2` axis).",
+              "description": "Sets the shape'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 an array of axis IDs is provided, each `y` value will refer to the corresponding axis, e.g., ['y', 'y2'] for a rectangle, line, or circle means `y0` uses the `y` axis and `y1` uses the `y2` axis. Path shapes using an array should have one entry for each y coordinate in the string.",
               "editType": "calc",
               "valType": "enumerated",
               "values": [
@@ -9969,7 +9969,7 @@
               "valType": "string"
             },
             "ysizemode": {
-              "description": "Sets the shapes's sizing mode along the y axis. If set to *scaled*, `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to *paper*). If set to *pixel*, `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction.",
+              "description": "Sets the shapes's sizing mode along the y axis. If set to *scaled*, `y0`, `y1` and y coordinates within `path` refer to data values on the y axis or a fraction of the plot area's height (`yref` set to *paper*). If set to *pixel*, `yanchor` specifies the y position in terms of data or plot fraction but `y0`, `y1` and y coordinates within `path` are pixels relative to `yanchor`. This way, the shape can have a fixed height while maintaining a position relative to data or plot fraction. Note: *pixel* mode is not supported when `yref` is an array.",
               "dflt": "scaled",
               "editType": "calc+arraydraw",
               "valType": "enumerated",