Misc doc

UnlyEd · Jan 16, 2021 · efaa158 · efaa158
1 parent f03499c
commit efaa158
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/src/components/utils/Tooltip.tsx b/src/components/utils/Tooltip.tsx
@@ -10,9 +10,11 @@ export type Props = {
   children: React.ReactElement;
 
   /**
-   * Text that will be displayed as the tooltip.
+   * Component that will be displayed as the tooltip.
    *
-   * Usually, something like `<span>Tooltip content</span>`
+   * Usually, something like `<span>Tooltip content</span>`.
+   *
+   * <span className="tip">XXX</span> If the content isn't placed in an element _(e.g: Fragment)_, [the whole React app will crash](https://github.com/react-component/tooltip/issues/239)!
    */
   overlay: (() => React.ReactNode) | React.ReactNode;