[Stepper] Improve the description of the icon prop (#16916)

mui · Aug 7, 2019 · 78db8a0 · 78db8a0
1 parent ba2b44c
commit 78db8a0
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 4 deletions.
diff --git a/docs/pages/api/step-icon.md b/docs/pages/api/step-icon.md
@@ -22,7 +22,7 @@ import StepIcon from '@material-ui/core/StepIcon';
 | <span class="prop-name">classes</span> | <span class="prop-type">object</span> |  | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
 | <span class="prop-name">completed</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as completed. Is passed to child components. |
 | <span class="prop-name">error</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as failed. |
-| <span class="prop-name required">icon&nbsp;*</span> | <span class="prop-type">node</span> |  | The icon displayed by the step label. |
+| <span class="prop-name required">icon&nbsp;*</span> | <span class="prop-type">node</span> |  | The label displayed in the step icon. |
 
 The `ref` is forwarded to the root element.
 

diff --git a/docs/pages/api/step-label.md b/docs/pages/api/step-label.md
@@ -22,7 +22,7 @@ import StepLabel from '@material-ui/core/StepLabel';
 | <span class="prop-name">classes</span> | <span class="prop-type">object</span> |  | Override or extend the styles applied to the component. See [CSS API](#css) below for more details. |
 | <span class="prop-name">disabled</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as disabled, will also disable the button if `StepLabelButton` is a child of `StepLabel`. Is passed to child components. |
 | <span class="prop-name">error</span> | <span class="prop-type">bool</span> | <span class="prop-default">false</span> | Mark the step as failed. |
-| <span class="prop-name">icon</span> | <span class="prop-type">node</span> |  | Override the default icon. |
+| <span class="prop-name">icon</span> | <span class="prop-type">node</span> |  | Override the default label of the step icon. |
 | <span class="prop-name">optional</span> | <span class="prop-type">node</span> |  | The optional node to display. |
 | <span class="prop-name">StepIconComponent</span> | <span class="prop-type">elementType</span> |  | The component to render in place of the [`StepIcon`](/api/step-icon/). |
 | <span class="prop-name">StepIconProps</span> | <span class="prop-type">object</span> |  | Props applied to the [`StepIcon`](/api/step-icon/) element. |

diff --git a/packages/material-ui/src/StepIcon/StepIcon.js b/packages/material-ui/src/StepIcon/StepIcon.js
@@ -82,7 +82,7 @@ StepIcon.propTypes = {
    */
   error: PropTypes.bool,
   /**
-   * The icon displayed by the step label.
+   * The label displayed in the step icon.
    */
   icon: PropTypes.node.isRequired,
 };

diff --git a/packages/material-ui/src/StepLabel/StepLabel.js b/packages/material-ui/src/StepLabel/StepLabel.js
@@ -179,7 +179,7 @@ StepLabel.propTypes = {
    */
   error: PropTypes.bool,
   /**
-   * Override the default icon.
+   * Override the default label of the step icon.
    */
   icon: PropTypes.node,
   /**