Merge pull request #8123 from Lexachoc/fix-typo-in-contour

docs: fix typos in `contour` trace

Author: camdecoster

src/traces/contour/attributes.js

@@ -45,14 +45,14 @@ module.exports = extendFlat(
         hovertemplatefallback: heatmapAttrs.hovertemplatefallback,
         texttemplate: extendFlat({}, heatmapAttrs.texttemplate, {
             description: [
-                'For this trace it only has an effect if `coloring` is set to *heatmap*.',
+                'For this trace it only has an effect if `contours.coloring` is set to *heatmap*.',
                 heatmapAttrs.texttemplate.description
             ].join(' ')
         }),
         texttemplatefallback: heatmapAttrs.texttemplatefallback,
         textfont: extendFlat({}, heatmapAttrs.textfont, {
             description: [
-                'For this trace it only has an effect if `coloring` is set to *heatmap*.',
+                'For this trace it only has an effect if `contours.coloring` is set to *heatmap*.',
                 heatmapAttrs.textfont.description
             ].join(' ')
         }),
@@ -203,7 +203,7 @@ module.exports = extendFlat(
 
                     '*[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]`',
 
-                    '*][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]`',
+                    '*][*, *)(*, *](*, *)[* keep regions outside `value[0]` to `value[1]`',
 
                     'Open vs. closed intervals make no difference to constraint display, but',
                     'all versions are allowed.'
@@ -243,9 +243,9 @@ module.exports = extendFlat(
                 min: 0,
                 editType: 'style+colorbars',
                 description: [
-                    'Sets the contour line width in (in px)',
+                    'Sets the contour line width (in px)',
                     'Defaults to *0.5* when `contours.type` is *levels*.',
-                    'Defaults to *2* when `contour.type` is *constraint*.'
+                    'Defaults to *2* when `contours.type` is *constraint*.'
                 ].join(' ')
             },
             dash: dash,

src/traces/contour/convert_to_constraints.js

@@ -23,7 +23,7 @@ module.exports = function(pathinfo, operation) {
                 Lib.warn('Contour data invalid for the specified inequality operation.');
             }
 
-            // In this case there should be exactly one contour levels in pathinfo.
+            // In this case there should be exactly one contour level in pathinfo.
             // We flip all of the data. This will draw the contour as closed.
             pi0 = pathinfo[0];
 

src/types/generated/schema.d.ts

@@ -2797,7 +2797,7 @@ export interface ContourData {
         /** Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. */
         labelformat?: string;
         /**
-         * Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed.
+         * Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to `value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed.
          * @default '='
          */
         operation?: '=' | '<' | '>=' | '>' | '<=' | '[]' | '()' | '[)' | '(]' | '][' | ')(' | '](' | ')[';
@@ -2904,7 +2904,7 @@ export interface ContourData {
          */
         smoothing?: number;
         /**
-         * Sets the contour line width in (in px) Defaults to *0.5* when `contours.type` is *levels*. Defaults to *2* when `contour.type` is *constraint*.
+         * Sets the contour line width (in px) Defaults to *0.5* when `contours.type` is *levels*. Defaults to *2* when `contours.type` is *constraint*.
          * Minimum: 0
          */
         width?: number;
@@ -2942,9 +2942,9 @@ export interface ContourData {
     showscale?: boolean;
     /** Sets the text elements associated with each z value. */
     text?: Datum[] | Datum[][] | TypedArray;
-    /** For this trace it only has an effect if `coloring` is set to *heatmap*. Sets the text font. */
+    /** For this trace it only has an effect if `contours.coloring` is set to *heatmap*. Sets the text font. */
     textfont?: Font;
-    /** For this trace it only has an effect if `coloring` is set to *heatmap*. Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`. */
+    /** For this trace it only has an effect if `contours.coloring` is set to *heatmap*. Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`. */
     texttemplate?: string;
     /**
      * Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.
@@ -3138,7 +3138,7 @@ export interface ContourcarpetData {
         /** Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. */
         labelformat?: string;
         /**
-         * Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed.
+         * Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to `value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed.
          * @default '='
          */
         operation?: '=' | '<' | '>=' | '>' | '<=' | '[]' | '()' | '[)' | '(]' | '][' | ')(' | '](' | ')[';
@@ -3227,7 +3227,7 @@ export interface ContourcarpetData {
          */
         smoothing?: number;
         /**
-         * Sets the contour line width in (in px) Defaults to *0.5* when `contours.type` is *levels*. Defaults to *2* when `contour.type` is *constraint*.
+         * Sets the contour line width (in px) Defaults to *0.5* when `contours.type` is *levels*. Defaults to *2* when `contours.type` is *constraint*.
          * Minimum: 0
          */
         width?: number;
@@ -4677,7 +4677,7 @@ export interface Histogram2dcontourData {
         /** Sets the contour label formatting rule using d3 formatting mini-languages which are very similar to those in Python. For numbers, see: https://github.com/d3/d3-format/tree/v1.4.5#d3-format. */
         labelformat?: string;
         /**
-         * Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed.
+         * Sets the constraint operation. *=* keeps regions equal to `value` *<* and *<=* keep regions less than `value` *>* and *>=* keep regions greater than `value` *[]*, *()*, *[)*, and *(]* keep regions inside `value[0]` to `value[1]` *][*, *)(*, *](*, *)[* keep regions outside `value[0]` to `value[1]` Open vs. closed intervals make no difference to constraint display, but all versions are allowed.
          * @default '='
          */
         operation?: '=' | '<' | '>=' | '>' | '<=' | '[]' | '()' | '[)' | '(]' | '][' | ')(' | '](' | ')[';
@@ -4823,9 +4823,9 @@ export interface Histogram2dcontourData {
      * @default true
      */
     showscale?: boolean;
-    /** For this trace it only has an effect if `coloring` is set to *heatmap*. Sets the text font. */
+    /** For this trace it only has an effect if `contours.coloring` is set to *heatmap*. Sets the text font. */
     textfont?: Font;
-    /** For this trace it only has an effect if `coloring` is set to *heatmap*. Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`. */
+    /** For this trace it only has an effect if `contours.coloring` is set to *heatmap*. Template string used for rendering the information text that appears on points. Note that this will override `textinfo`. Variables are inserted using %{variable}, for example "y: %{y}". Numbers are formatted using d3-format's syntax %{variable:d3-format}, for example "Price: %{y:$.2f}". https://github.com/d3/d3-format/tree/v1.4.5#d3-format for details on the formatting syntax. Dates are formatted using d3-time-format's syntax %{variable|d3-time-format}, for example "Day: %{2019-01-01|%A}". https://github.com/d3/d3-time-format/tree/v2.2.3#locale_format for details on the date formatting syntax. Variables that can't be found will be replaced with the specifier. For example, a template of "data: %{x}, %{y}" will result in a value of "data: 1, %{y}" if x is 1 and y is missing. Variables with an undefined value will be replaced with the fallback value. All attributes that can be specified per-point (the ones that are `arrayOk: true`) are available. Finally, the template string has access to variables `x`, `y`, `z` and `text`. */
     texttemplate?: string;
     /**
      * Fallback string that's displayed when a variable referenced in a template is missing. If the boolean value 'false' is passed in, the specifier with the missing variable will be displayed.