Fix JSdoc syntax to make parameter required

WordPress · Apr 19, 2023 · c2fff09 · c2fff09
1 parent b1bf4dc
commit c2fff09
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/docs/reference-guides/data/data-core-notices.md b/docs/reference-guides/data/data-core-notices.md
@@ -156,7 +156,7 @@ const ExampleComponent = () => {
 
 _Parameters_
 
--   _status_ `[string]`: Notice status.
+-   _status_ `string|undefined`: Notice status ("info" if undefined is passed).
 -   _content_ `string`: Notice message.
 -   _options_ `[Object]`: Notice options.
 -   _options.context_ `[string]`: Context under which to group notice.

diff --git a/packages/notices/src/store/actions.js b/packages/notices/src/store/actions.js
@@ -19,7 +19,7 @@ let uniqueId = 0;
 /**
  * Returns an action object used in signalling that a notice is to be created.
  *
- * @param {string}                [status='info']              Notice status.
+ * @param {string|undefined}      status                       Notice status ("info" if undefined is passed).
  * @param {string}                content                      Notice message.
  * @param {Object}                [options]                    Notice options.
  * @param {string}                [options.context='global']   Context under which to