Merge pull request #7469 from plotly/fix-doc-formatting

fix: minor documentation formatting issues

Author: LiamConnors

src/components/annotations/attributes.js

@@ -49,9 +49,9 @@ module.exports = templatedArray('annotation', {
         description: [
             'Sets the text associated with this annotation.',
             'Plotly uses a subset of HTML tags to do things like',
-            'newline (<br>), bold (<b></b>), italics (<i></i>),',
-            'hyperlinks (<a href=\'...\'></a>). Tags <em>, <sup>, <sub>, <s>, <u>',
-            '<span> are also supported.'
+            'newline (`<br>`), bold (`<b></b>`), italics (`<i></i>`),',
+            'hyperlinks (`<a href=\'...\'></a>`). Tags `<em>`, `<sup>`,',
+            '`<sub>`, `<s>`, `<u>`, and `<span>` are also supported.'
         ].join(' ')
     },
     textangle: {

src/components/errorbars/attributes.js

@@ -16,7 +16,7 @@ module.exports = {
         description: [
             'Determines the rule used to generate the error bars.',
 
-            'If *constant`, the bar lengths are of a constant value.',
+            'If *constant*, the bar lengths are of a constant value.',
             'Set this constant in `value`.',
 
             'If *percent*, the bar lengths correspond to a percentage of',

src/plots/cartesian/layout_attributes.js

@@ -335,7 +335,7 @@ module.exports = {
         description: [
             'If *normal*, the range is computed in relation to the extrema',
             'of the input data.',
-            'If *tozero*`, the range extends to 0,',
+            'If *tozero*, the range extends to 0,',
             'regardless of the input data',
             'If *nonnegative*, the range is non-negative,',
             'regardless of the input data.',

src/plots/polar/layout_attributes.js

@@ -74,7 +74,7 @@ var radialAxisAttrs = {
         dflt: 'tozero',
         editType: 'calc',
         description: [
-            'If *tozero*`, the range extends to 0,',
+            'If *tozero*, the range extends to 0,',
             'regardless of the input data',
             'If *nonnegative*, the range is non-negative,',
             'regardless of the input data.',

src/plots/template_attributes.js

@@ -76,7 +76,7 @@ exports.hovertemplateAttrs = function(opts, extra) {
             'The variables available in `hovertemplate` are the ones emitted as event data described at this link https://plotly.com/javascript/plotlyjs-events/#event-data.',
             'Additionally, every attributes that can be specified per-point (the ones that are `arrayOk: true`) are available.',
             descPart,
-            'Anything contained in tag `<extra>` is displayed in the secondary box, for example "<extra>{fullData.name}</extra>".',
+            'Anything contained in tag `<extra>` is displayed in the secondary box, for example `<extra>%{fullData.name}</extra>`.',
             'To hide the secondary box completely, use an empty tag `<extra></extra>`.'
         ].join(' ')
     };

src/traces/carpet/axis_attributes.js

@@ -86,7 +86,7 @@ module.exports = {
         description: [
             'If *normal*, the range is computed in relation to the extrema',
             'of the input data.',
-            'If *tozero*`, the range extends to 0,',
+            'If *tozero*, the range extends to 0,',
             'regardless of the input data',
             'If *nonnegative*, the range is non-negative,',
             'regardless of the input data.'

src/traces/contour/attributes.js

@@ -226,11 +226,11 @@ module.exports = extendFlat({
                 'Sets the value or values of the constraint boundary.',
 
                 'When `operation` is set to one of the comparison values',
-                '(' + COMPARISON_OPS2 + ')',
+                '(`' + COMPARISON_OPS2 + '`)',
                 '*value* is expected to be a number.',
 
                 'When `operation` is set to one of the interval values',
-                '(' + INTERVAL_OPS + ')',
+                '(`' + INTERVAL_OPS + '`)',
                 '*value* is expected to be an array of two numbers where the first',
                 'is the lower bound and the second is the upper bound.',
             ].join(' ')