Provide better description of RawHTMLProps

WordPress · Apr 3, 2020 · 8bed5cf · 8bed5cf
1 parent c6722b2
commit 8bed5cf
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/packages/element/README.md b/packages/element/README.md
@@ -289,7 +289,7 @@ aside from `children` are passed.
 
 _Parameters_
 
--   _props_ `RawHTMLProps`: 
+-   _props_ `RawHTMLProps`: Children should be a string of HTML. Other props will be passed through to div wrapper.
 
 _Returns_
 

diff --git a/packages/element/src/raw-html.js b/packages/element/src/raw-html.js
@@ -14,7 +14,8 @@ import { createElement } from './react';
  * To preserve additional props, a `div` wrapper _will_ be created if any props
  * aside from `children` are passed.
  *
- * @param {RawHTMLProps} props
+ * @param {RawHTMLProps} props Children should be a string of HTML. Other props
+ *                             will be passed through to div wrapper.
  *
  * @return {JSX.Element} Dangerously-rendering component.
  */