add deprecation warning to legacy polar charts attr descriptions

Author: etpinard

src/plots/polar/legacy/axis_attributes.js

@@ -13,6 +13,8 @@ var axesAttrs = require('../../cartesian/layout_attributes');
 var extendFlat = require('../../../lib/extend').extendFlat;
 var overrideAll = require('../../../plot_api/edit_types').overrideAll;
 
+var deprecationWarning = 'Legacy polar charts are deprecated!';
+
 var domainAttr = extendFlat({}, axesAttrs.domain, {
     description: [
         'Polar chart subplots are not supported yet.',
@@ -26,6 +28,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
             valType: 'boolean',
             role: 'style',
             description: [
+                deprecationWarning,
                 'Determines whether or not the line bounding this',
                 axisName, 'axis',
                 'will be shown on the figure.'
@@ -35,6 +38,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
             valType: 'boolean',
             role: 'style',
             description: [
+                deprecationWarning,
                 'Determines whether or not the',
                 axisName, 'axis ticks',
                 'will feature tick labels.'
@@ -45,6 +49,7 @@ function mergeAttrs(axisName, nonCommonAttrs) {
             values: ['horizontal', 'vertical'],
             role: 'style',
             description: [
+                deprecationWarning,
                 'Sets the orientation (from the paper perspective)',
                 'of the', axisName, 'axis tick labels.'
             ].join(' ')
@@ -54,31 +59,36 @@ function mergeAttrs(axisName, nonCommonAttrs) {
             min: 0,
             role: 'style',
             description: [
+                deprecationWarning,
                 'Sets the length of the tick lines on this', axisName, 'axis.'
             ].join(' ')
         },
         tickcolor: {
             valType: 'color',
             role: 'style',
             description: [
+                deprecationWarning,
                 'Sets the color of the tick lines on this', axisName, 'axis.'
             ].join(' ')
         },
         ticksuffix: {
             valType: 'string',
             role: 'style',
             description: [
+                deprecationWarning,
                 'Sets the length of the tick lines on this', axisName, 'axis.'
             ].join(' ')
         },
         endpadding: {
             valType: 'number',
-            role: 'style'
+            role: 'style',
+            description: deprecationWarning,
         },
         visible: {
             valType: 'boolean',
             role: 'info',
             description: [
+                deprecationWarning,
                 'Determines whether or not this axis will be visible.'
             ].join(' ')
         }
@@ -97,6 +107,7 @@ module.exports = overrideAll({
                 { valType: 'number' }
             ],
             description: [
+                deprecationWarning,
                 'Defines the start and end point of this radial axis.'
             ].join(' ')
         },
@@ -105,6 +116,7 @@ module.exports = overrideAll({
             valType: 'number',
             role: 'style',
             description: [
+                deprecationWarning,
                 'Sets the orientation (an angle with respect to the origin)',
                 'of the radial axis.'
             ].join(' ')
@@ -120,6 +132,7 @@ module.exports = overrideAll({
                 { valType: 'number', dflt: 360 }
             ],
             description: [
+                deprecationWarning,
                 'Defines the start and end point of this angular axis.'
             ].join(' ')
         },
@@ -133,16 +146,18 @@ module.exports = overrideAll({
             values: ['clockwise', 'counterclockwise'],
             role: 'info',
             description: [
-                'For polar plots only.',
-                'Sets the direction corresponding to positive angles.'
+                deprecationWarning,
+                'Sets the direction corresponding to positive angles',
+                'in legacy polar charts.'
             ].join(' ')
         },
         orientation: {
             valType: 'angle',
             role: 'info',
             description: [
-                'For polar plots only.',
-                'Rotates the entire polar by the given angle.'
+                deprecationWarning,
+                'Rotates the entire polar by the given angle',
+                'in legacy polar charts.'
             ].join(' ')
         }
     }