chore(buttons): update prop descriptions (#953)

Co-authored-by: Mikaela <mikaela.gurney@zendesk.com>

packages/buttons/src/elements/Anchor.tsx

@@ -10,12 +10,12 @@ import PropTypes from 'prop-types';
 import { StyledAnchor, StyledExternalIcon } from '../styled';
 
 export interface IAnchorProps extends AnchorHTMLAttributes<HTMLAnchorElement> {
-  /** Apply danger styling */
+  /** Applies danger styling */
   isDanger?: boolean;
   /**
-   * Used when the anchor navigates to an external resource. Applies `target="_blank"`
-   * along with `rel="noopener noreferrer"` to ensure safe
-   * [cross-origin destination links](https://web.dev/external-anchors-use-rel-noopener/).
+   * Attaches `target="_blank"` and `rel="noopener noreferrer"` to an anchor that
+   * navigates to an external resource. This ensures ensures that the anchor is a
+   * safe [cross-origin destination link](https://web.dev/external-anchors-use-rel-noopener/).
    **/
   isExternal?: boolean;
 }

packages/buttons/src/elements/Button.tsx

@@ -12,18 +12,19 @@ import { useButtonGroupContext } from '../utils/useButtonGroupContext';
 import { useSplitButtonContext } from '../utils/useSplitButtonContext';
 
 export interface IButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
-  /** Apply danger styling */
+  /** Applies danger styling */
   isDanger?: boolean;
+  /** Specifies the buton size */
   size?: 'small' | 'medium' | 'large';
-  /** Stretch the button to its container width */
+  /** Stretches the button fill to its container width */
   isStretched?: boolean;
   /** Applies primary button styling */
   isPrimary?: boolean;
   /** Applies basic button styling */
   isBasic?: boolean;
   /** Applies link (anchor) button styling */
   isLink?: boolean;
-  /** Applies pill styling */
+  /** Applies pill button styling */
   isPill?: boolean;
   /** Applies inset `box-shadow` styling on focus */
   focusInset?: boolean;

packages/buttons/src/elements/ButtonGroup.tsx

@@ -13,12 +13,18 @@ import { StyledButtonGroup } from '../styled';
 import { ButtonGroupContext } from '../utils/useButtonGroupContext';
 
 export interface IButtonGroupProps extends HTMLAttributes<HTMLDivElement> {
+  /** Defines the currently selected button in the group */
   selectedItem?: any;
+  /**
+   * Handles button selection
+   *
+   * @param {any} item The selected item
+   */
   onSelect?: (item: any) => void;
 }
 
 /**
- * High-level abstraction for basic ButtonGroup implementations.
+ * High-level abstraction for basic ButtonGroup implementations
  */
 const ButtonGroup: React.FunctionComponent<IButtonGroupProps> = ({
   children,

packages/buttons/src/elements/IconButton.tsx

@@ -13,16 +13,17 @@ import { useSplitButtonContext } from '../utils/useSplitButtonContext';
 export interface IIconButtonProps extends ButtonHTMLAttributes<HTMLButtonElement> {
   /** Applies primary button styling */
   isPrimary?: boolean;
-  /** Apply danger styling */
+  /** Applies danger button styling */
   isDanger?: boolean;
   /** Applies basic button styling */
   isBasic?: boolean;
-  /** Applies pill styling */
+  /** Applies pill button styling */
   isPill?: boolean;
   /** Applies inset `box-shadow` styling on focus */
   focusInset?: boolean;
   /** Rotates icon 180 degrees */
   isRotated?: boolean;
+  /** Specifies icon button size */
   size?: 'small' | 'medium' | 'large';
 }
 

packages/buttons/src/elements/ToggleButton.tsx

@@ -11,17 +11,16 @@ import Button, { IButtonProps } from './Button';
 
 export interface IToggleButtonProps extends IButtonProps {
   /**
-   * Determine if the button is pressed or not. Use `'mixed'` to indicate
-   * whether the toggle controls other elements which do not share the same
-   * value.
+   * Determines if the button is pressed. Use "mixed" to indicate that
+   * the toggle controls other elements which do not share the same value.
    */
   isPressed?: boolean | 'mixed';
 }
 
 /**
  * A `Button` with the [ARIA
  * attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/button_role#Toggle_buttons)
- * to indicate a pressed state.
+ * to indicate a pressed state
  */
 const ToggleButton: React.FunctionComponent<
   IToggleButtonProps & React.RefAttributes<HTMLButtonElement>

packages/buttons/src/elements/ToggleIconButton.tsx

@@ -11,17 +11,16 @@ import IconButton, { IIconButtonProps } from './IconButton';
 
 export interface IToggleIconButtonProps extends IIconButtonProps {
   /**
-   * Determine if the icon button is pressed or not. Use `'mixed'` to indicate
-   * whether the toggle controls other elements which do not share the same
-   * value.
+   * Determines if the button is pressed. Use "mixed" to indicate that the
+   * toggle controls other elements which do not share the same value.
    */
   isPressed?: boolean | 'mixed';
 }
 
 /**
  * A `IconButton` with the [ARIA
  * attribute](https://developer.mozilla.org/en-US/docs/Web/Accessibility/ARIA/Roles/button_role#Toggle_buttons)
- * to indicate a pressed state.
+ * to indicate a pressed state
  */
 const ToggleIconButton: React.FunctionComponent<
   IToggleIconButtonProps & React.RefAttributes<HTMLButtonElement>