[ios, macos] Omit unwieldy units from struct descriptions

mapbox · Jan 6, 2018 · 5374da2 · 5374da2
1 parent 41c7b4d
commit 5374da2
Show file tree

Hide file tree

Showing 2 changed files with 25 additions and 17 deletions.
diff --git a/platform/darwin/scripts/generate-style-code.js b/platform/darwin/scripts/generate-style-code.js
@@ -30,7 +30,11 @@ _.forOwn(cocoaConventions, function (properties, kind) {
         // Update cross-references to this property in other properties'
         // documentation and requirements.
         let renameCrossReferences = function (property, name) {
-            property.doc = property.doc.replace(new RegExp('`' + oldName + '`', 'g'), '`' + newName + '`');
+            let oldNameRe = new RegExp('`' + oldName + '`', 'g');
+            property.doc = property.doc.replace(oldNameRe, '`' + newName + '`');
+            if (property.units) {
+                property.units = property.units.replace(oldNameRe, '`' + newName + '`');
+            }
             let requires = property.requires || [];
             for (let i = 0; i < requires.length; i++) {
                 if (requires[i] === oldName) {
@@ -265,10 +269,7 @@ global.propertyDoc = function (propertyName, property, layerType, kind) {
     });
     // Format references to units.
     if ('units' in property) {
-        if (!property.units.match(/s$/)) {
-            property.units += 's';
-        }
-        doc += `\n\nThis property is measured in ${property.units}.`;
+        doc += `\n\nThis property is measured in ${describeUnit(property.units, property, layerType)}.`;
     }
     doc = doc.replace(/(p)ixel/gi, '$1oint').replace(/(\d)px\b/g, '$1pt');
     if (kind !== 'enum') {
@@ -344,6 +345,13 @@ global.parseColor = function (str) {
     };
 };
 
+global.describeUnit = function (unit, property, layerType) {
+    if (!unit.match(/s$|s /)) {
+        unit += 's';
+    }
+    return unit.replace(/pixel/, 'point');
+};
+
 global.describeValue = function (value, property, layerType) {
     switch (property.type) {
         case 'boolean':
@@ -389,9 +397,13 @@ global.describeValue = function (value, property, layerType) {
             }
             return 'a `UIColor`' + ` object whose RGB value is ${color.r}, ${color.g}, ${color.b} and whose alpha value is ${color.a}`;
         case 'array':
-            let units = property.units || '';
+            let units = property.units;
             if (units) {
-                units = ` ${units}`.replace(/pixel/, 'point');
+                units = ` ${describeUnit(units, property, layerType)}`;
+                // Omit unwieldy phrases that occur as units.
+                if (units.split(' ').length > 2) {
+                    units = '';
+                }
             }
             switch (arrayType(property)) {
                 case 'padding':

diff --git a/platform/darwin/src/MGLSymbolStyleLayer.h b/platform/darwin/src/MGLSymbolStyleLayer.h
@@ -479,13 +479,11 @@ MGL_EXPORT
 /**
  Offset distance of icon from its anchor.
  
- This property is measured in points multiplied by the value of "icon-size"s.
+ This property is measured in points multiplied by the value of "icon-size".
  
  The default value of this property is an `MGLStyleValue` object containing an
- `NSValue` object containing a `CGVector` struct set to 0 points multiplied by
- the value of "icon-size"s rightward and 0 points multiplied by the value of
- "icon-size"s downward. Set this property to `nil` to reset it to the default
- value.
+ `NSValue` object containing a `CGVector` struct set to 0 rightward and 0
+ downward. Set this property to `nil` to reset it to the default value.
  
  This property is only applied to the style if `iconImageName` is non-`nil`.
  Otherwise, it is ignored.
@@ -511,13 +509,11 @@ MGL_EXPORT
 /**
  Offset distance of icon from its anchor.
  
- This property is measured in points multiplied by the value of "icon-size"s.
+ This property is measured in points multiplied by the value of "icon-size".
  
  The default value of this property is an `MGLStyleValue` object containing an
- `NSValue` object containing a `CGVector` struct set to 0 points multiplied by
- the value of "icon-size"s rightward and 0 points multiplied by the value of
- "icon-size"s upward. Set this property to `nil` to reset it to the default
- value.
+ `NSValue` object containing a `CGVector` struct set to 0 rightward and 0
+ upward. Set this property to `nil` to reset it to the default value.
  
  This property is only applied to the style if `iconImageName` is non-`nil`.
  Otherwise, it is ignored.